Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pabloxt14/rocketnotes-web
O Rocketnotes é uma aplicação web na qual os usuários podem se cadastrar e criar de forma organizada anotações sobre determinados assuntos
https://github.com/pabloxt14/rocketnotes-web
react react-query react-router react-toastify styled-components
Last synced: about 2 months ago
JSON representation
O Rocketnotes é uma aplicação web na qual os usuários podem se cadastrar e criar de forma organizada anotações sobre determinados assuntos
- Host: GitHub
- URL: https://github.com/pabloxt14/rocketnotes-web
- Owner: PabloXT14
- License: mit
- Created: 2023-01-14T18:08:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T02:44:25.000Z (over 1 year ago)
- Last Synced: 2023-10-18T03:42:32.384Z (over 1 year ago)
- Topics: react, react-query, react-router, react-toastify, styled-components
- Language: TypeScript
- Homepage: https://rocketnotesweb.netlify.app/
- Size: 3.82 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rocketnotes Web
🚀 Aplicação Finalizada 🚀
About |
Layout |
Deploy |
How It Works |
Technologies |
Author |
License
## 💻 About
O Rocketnotes é uma aplicação web na qual os usuários podem se cadastrar e criar de forma organizada anotações sobre determinados assuntos, tendo disponível a adição de titulo, descrição, links e tags para cada nota, além de contar a edição de perfil do usuário, podendo alterar seu avatar, nome, email e senha.
Vale ressaltar que este projeto faz parte da trilha/curso **Explorer** oferecida pela [Rocketseat](https://www.rocketseat.com.br/) para quem tiver interesse.
---
## 🎨 Layout
Você pode visualizar o layout do projeto através [desse link](https://www.figma.com/file/t5Du3GRsK7AXLcUBDMbiV6/RocketNotes/duplicate). É necessário ter conta no [Figma](https://www.figma.com/) para acessá-lo.
### Web
#### SignUp
#### SignIn
#### Home
#### Perfil
#### Note Preview
#### Note Create
---
## 🔗 Deploy
Para acessar o deploy do Website da aplicação basta clicar no link a seguir: [Link](https://rocketnotesweb.netlify.app/)
> Obs: a aplicação pode demorar um pouco para entrar na primeira execução depois de um tempo, devido ao back-end estar rodando através do plano gratuito na plataforma de hospedagem.
---
## 🚀 How it works
Este projeto contem parte Front-end(React) e Back-end(Node), no entanto, neste repositório só está a parte Front-end Web, para acessar o repositório do Back-end acesse o seguinte [link](https://github.com/PabloXT14/Rocketnotes-API)
### Pré-requisitos
Antes de baixar o projeto você vai precisar ter instalado na sua máquina as seguintes ferramentas:
* [Git](https://git-scm.com)
* [NodeJS](https://nodejs.org/en/)
* [Yarn](https://yarnpkg.com/) ou [NPM](https://www.npmjs.com/)
Além disto é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
> Obs: e não se esqueça que também precisa rodar/executar o back-end da aplicação para buscar e checar os dados necessários
#### 🧭 Rodando a aplicação web (Frontend)
```bash
# Clone este repositório
$ git clone [email protected]:pabloxt14/Rocketnotes-Web.git
# Vá para a pasta da aplicação Front End
$ cd Rocketnotes-Web
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# A aplicação será aberta em uma porta especificada no terminal de execução
```
---
## 🛠 Technologies
As seguintes ferramentas foram usadas na construção do projeto:
#### **Website** ([Vite](https://vitejs.dev/) + [TypeScript](https://www.typescriptlang.org/))
- **[Styled-Components](https://styled-components.com/)**
- **[React-Toastify](https://fkhadra.github.io/react-toastify/introduction)**
- **[React-Query](https://react-query-v3.tanstack.com/)**
- **[React-Icons](https://react-icons.github.io/react-icons/)**
- **[React-Loader-Spinner](https://mhnpd.github.io/react-loader-spinner/docs/intro)**
- **[React-Router-DOM](https://reactrouter.com/en/main/start/tutorial)**
> Para mais detalhes das dependências gerais da aplicação veja o arquivo [package.json](https://github.com/PabloXT14/Rocketnotes-Web/blob/main/package.json)
---
## ✍ Author
[](https://www.linkedin.com/in/pabloalan/)
[](mailto:[email protected])
---
## 📝 License
Este projeto esta sobe a licença [MIT](./LICENSE).
Feito com 💜 por Pablo Alan 👋🏽 [Entre em contato!](https://www.linkedin.com/in/pabloalan/)