guzsarchives/Homework.app
Archived
1
0
Fork 0
Code Issues Pull Requests Activity

repository info

Browse Source
This commit is contained in:
Guz
2022-04-08 23:33:57 -03:00
parent 08a441d2e2
commit 76ff1ca741
6 changed files with 90 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
.github/README.md vendored Normal file
View File

@@ -0,0 +1,87 @@
<div align="center">
# Homework.app `[WIP]`
_[homework-guz.vercel.app][appurl]_
![guz-badge] ![license-badge] ![version-badge] ![production-status-badge] ![preview-status-badge]
> This is a personal project created for learning purposes. It isn't intended to be a complete, full-featured, or user-ready web application.
</div>
---
## About & Idea :bulb:
An app designed to help students with some concepts learned in school, primarily things that can be tedious to do or that simply look good to see in action (like graphs, physics, etc.).
It's made to have the most satisfying interface and gestures possible, following a minimalistic style, with smooth colors and contrasts with black and white.
## Purpose :sparkles:
The web application is primarily created as a learning project, focusing on these concepts mainly:
- :art: UI/UX design;
- :iphone: Mobile-first and responsive interface;
- :gear: Configurable application;
- :brazil: Multiple languages support;
- :black_nib: Animations;
- :atom_symbol: Learn more about React/Next.js;
## Tools :toolbox:
These are the main tools, packages, technologies used in this project:
<table>
<thead>
<th><b>Framework / Environment</b></th>
<th><b>Design</b></th>
<th><b>Development</b></th>
<th><b>Deployment</b></th>
</thead>
<tbody>
<th>
<abbr title="React"><a href="https://reactjs.org/"><img src='https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/react/react.png' width='30'/></a></abbr>
<abbr title="Next.js"><a href="https://nextjs.org/"><img src='https://assets.vercel.com/image/upload/v1607554385/repositories/next-js/next-logo.png' width='30'/></a></abbr>
<abbr title="Typescript"><a href="https://www.typescriptlang.org/"><img src='https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/typescript/typescript.png' width='30'/></a></abbr>
</th>
<th>
<abbr title="Tailwind CSS"><a href="https://tailwindcss.com/"><img src='https://tailwindcss.com/_next/static/media/tailwindcss-mark.79614a5f61617ba49a0891494521226b.svg' width='35'/></a></abbr>
<abbr title="Heroicons"><a href="https://heroicons.com/"><img src='https://heroicons.com/_next/static/media/favicon-32x32.eee32601ba9d4702f841835990ed3801.png' width='30'/></a></abbr>
</th>
<th>
<abbr title="ESLint"><a href="https://eslint.org/"><img src='https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/eslint/eslint.png' width='30'/></a></abbr>
<abbr title="Prettier"><a href="https://prettier.io/"><img src='https://prettier.io/icon.png' width='30'/></a></abbr>
<abbr title="EditorConfig"><a href="https://editorconfig.org/"><img src='https://editorconfig.org/logo.png' width='30'/></a></abbr>
<abbr title="pnpm"><a href="https://pnpm.io/"><img src='https://d33wubrfki0l68.cloudfront.net/2f3acb83b7d2349f2194bc38c0f22f295908dc33/43f95/img/pnpm-no-name-with-frame.svg' width='30'/></a></abbr>
</th>
<th>
<abbr title="Deploy with vercel"><a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FGuz013%2FHomework.app"><img src='https://vercel.com/button' width='90'/></a></abbr>
</th>
</tbody>
</table>
> Other tools were used, but they were not totally essential to the project. Also, the tools listed are personal preferences and chosen for a better development experience.
## License :page_facing_up:
The content of the application and project itself is licensed under the [CC-BY-SA 4.0 License][cclicenseurl], and the underlying source code used to display, format and interact with the content is licensed under the [MIT License][mitlicenseurl].
<img src='./misc/watermark.png' width='25'> &copy; 2022 Gustavo "Guz" L. de Mello
[cclicenseurl]: https://creativecommons.org/licenses/by-sa/4.0/
[mitlicenseurl]: https://github.com/Guz013/Homework.app/blob/main/LICENSE
[deployurl]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FGuz013%2FHomework.app
[appurl]: https://homework-guz.vercel.app
[guz-badge]: https://img.shields.io/badge/By-Guz013-white?style=flat-square&labelColor=f4f4f5&color=18181b
[version-badge]: https://img.shields.io/github/package-json/v/guz013/homework.app?style=flat-square&label=Version&logo=github&logoColor=18181b&labelColor=f4f4f5&color=18181b
[license-badge]: https://img.shields.io/github/license/guz013/homework.app?style=flat-square&label=License&logo=Open%20Source%20Initiative&logoColor=18181b&labelColor=f4f4f5&color=18181b
[production-status-badge]: https://img.shields.io/github/deployments/guz013/homework.app/production?label=Production&logo=vercel&logoColor=18181b&style=flat-square&labelColor=f4f4f5
[preview-status-badge]: https://img.shields.io/github/deployments/guz013/homework.app/preview?label=Preview&logo=react&logoColor=18181b&style=flat-square&labelColor=f4f4f5

BIN
.github/misc/watermark.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.6 KiB

1
.vscode/settings.json vendored
View File

@@ -1,6 +1,7 @@
{
"cSpell.words": [
"heroicons",
"pnpm",
"Swipeable"
],
"typescript.tsdk": "node_modules\\typescript\\lib"

2
LICENSE
View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2022 Guz
Copyright (c) 2022 Gustavo "Guz" L. de Mello
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

23
README.md
View File

@@ -1,23 +0,0 @@
# Progressive Web App Example
This example uses [`next-pwa`](https://github.com/shadowwalker/next-pwa) to create a progressive web app (PWA) powered by [Workbox](https://developers.google.com/web/tools/workbox/).
## Deploy your own
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/progressive-web-app&project-name=progressive-web-app&repository-name=progressive-web-app)
## How to use
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
```bash
npx create-next-app --example progressive-web-app progressive-web-app
# or
yarn create next-app --example progressive-web-app progressive-web-app
# or
pnpm create next-app -- --example progressive-web-app progressive-web-app
```
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

1
package.json
View File

@@ -1,4 +1,5 @@
{
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "next dev",