Project Dev é uma API robusta desenvolvida em Node.js que serve como backend para uma aplicação inspirada no Instagram. Este projeto foi criado como parte de um bootcamp para demonstrar boas práticas de desenvolvimento de APIs RESTful.
Project Dev is a robust API developed in Node.js that serves as the backend for an Instagram-inspired application. This project was created as part of a bootcamp to demonstrate best practices in RESTful API development.
- Clone o repositório / Clone the repository:
git clone https://github.com/nikumu/api-project-dev
- Entre no diretório do projeto / Enter the project directory:
cd api-project-dev
- Instale as dependências / Install the dependencies:
npm install
- Configure as variáveis de ambiente / Set up environment variables:
- Crie um arquivo
.env
na raiz do projeto / Create a.env
file in the project root - Adicione as variáveis necessárias (consulte
.env.example
se disponível) / Add the necessary variables (check.env.example
if available)
- Inicie o servidor de desenvolvimento / Start the development server:
npm run dev
Após iniciar o servidor, a API estará disponível em http://localhost:3000
(ou a porta que você configurou).
After starting the server, the API will be available at http://localhost:3000
(or the port you've configured).
POST /users
: Criar um novo usuário / Create a new userPOST /login
: Autenticar um usuário / Authenticate a userGET /posts
: Listar posts / List postsPOST /posts
: Criar um novo post / Create a new postPOST /posts/:id/like
: Curtir um post / Like a postPOST /posts/:id/comment
: Comentar em um post / Comment on a post
Contribuições são bem-vindas! Por favor, leia as diretrizes de contribuição antes de submeter pull requests.
Contributions are welcome! Please read the contribution guidelines before submitting pull requests.
Este projeto está licenciado sob a Licença MIT.
This project is licensed under the MIT License.