A JavaScript Notes API é o backend da aplicação JavaScript Notes, que permite aos usuários criar e gerenciar notas pessoais. Esta API gerencia a autenticação, o armazenamento de dados e a comunicação com o frontend da aplicação. É construída com Node.js e utiliza Express para o gerenciamento das rotas e Mongoose para interagir com o banco de dados MongoDB.
- Node.js: Ambiente de execução JavaScript no lado do servidor.
- Express: Framework para criar APIs e gerenciar rotas.
- Mongoose: Biblioteca para modelar dados e interagir com o MongoDB.
- Axios: Cliente HTTP para realizar requisições à APIs externas, se necessário.
- bcrypt: Biblioteca para hashing de senhas e autenticação.
- jsonwebtoken: Para gerar e verificar tokens JWT.
- dotenv: Para gerenciar variáveis de ambiente.
- cors: Para habilitar CORS (Cross-Origin Resource Sharing).
- morgan: Middleware de logging de requisições HTTP.
- node-fetch: Para realizar requisições HTTP, se necessário.
- Autenticação de usuários com JWT.
- Armazenamento e gerenciamento de notas.
- Conexão com banco de dados MongoDB.
- Node.js (versão 20.x)
- npm (ou yarn)
git clone https://github.com/seu-usuario/javascript_note_api.git
cd javascript_note_api
Usando npm:
npm install
ou, se estiver usando yarn:
yarn install
-
Crie um arquivo
.env
na raiz do projeto e adicione as seguintes variáveis de ambiente:MONGODB_URI=SuaUriDoMongoDBAqui JWT_SECRET=SeuSecretJWTAqui
-
Substitua SuaUriDoMongoDBAqui pela URI de conexão com o MongoDB.
-
Substitua SeuSecretJWTAqui pela chave secreta para assinatura de tokens JWT.
-
Inicie o servidor de desenvolvimento:
Usando npm:
npm run dev
ou, se estiver usando yarn:
yarn run dev
- start: 🖥️ Inicia o servidor em modo de produção.
- dev: 🧪 Inicia o servidor em modo de desenvolvimento com nodemon.
- build: 📦 (Não aplicável para esta aplicação, já que não há construção de frontend).
- 🍴 Faça um fork deste repositório.
- 🌿 Crie uma nova branch (
git checkout -b minha-feature
). - 💻 Faça suas alterações e commite-as (
git commit -am 'Adiciona nova feature'
). - 📤 Envie suas alterações para o repositório remoto (
git push origin minha-feature
). - 🔄 Abra um Pull Request para a branch principal do projeto.
📜 Este projeto está licenciado sob a Licença MIT.
📧 Wallace - wallacesantanak0@gmail.com
🐙 GitHub: wallacemt