Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fel1324/momentsapi
API foi desenvolvida na vídeo aula de API RESTful com AdonisJS, do canal Matheus Battisti, no YouTube.
https://github.com/fel1324/momentsapi
adonisjs api git github nodejs sqlite
Last synced: 15 days ago
JSON representation
API foi desenvolvida na vídeo aula de API RESTful com AdonisJS, do canal Matheus Battisti, no YouTube.
- Host: GitHub
- URL: https://github.com/fel1324/momentsapi
- Owner: Fel1324
- License: mit
- Created: 2024-07-25T23:16:59.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-25T13:46:15.000Z (about 1 month ago)
- Last Synced: 2024-11-25T14:37:23.670Z (about 1 month ago)
- Topics: adonisjs, api, git, github, nodejs, sqlite
- Language: TypeScript
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
📱 Moments API ⚙️
API desenvolvida na vídeo aula de API RESTful com AdonisJS, do canal Matheus Battisti - Hora de Codar, no YouTube.
## Tópicos
- [Sobre a API](#sobre)
- [Rotas da API](#routes)
- [Tecnologias utilizadas](#tec)
- [Executando a API](#exec)
- [Créditos](#cred)
- [Status da API](#status)
- [Licença](#license)
📸 Sobre o projeto
API que será consumida por uma página de cadastro de momentos, onde os usuários podem ver e comentar nos momentos de outros.
🛠️ Rotas da API
GET
- **/moments**: Retorna todos os momentos.
- **/moments/:momentId**: Retorna um momento específico pelo ID.
- **/moments/:momentId/comments/**: Retorna todos os comentários do momento ao qual eles pertencem.
- **/moments/:momentId/comments/:id**: Retorna um comentário específico, pelo ID, do momento ao qual ele pertence.
- **/uploads/:filename**: Retorna todos os arquivos.
POST
- **/moments**: Cria um novo momento.
- **/moments/:momentId/comments/**: Cria um novo comentário em um determinado momento.
PATCH
- **/moments/:momentId**: Atualiza um momento específico pelo ID.
- **/moments/:momentId/comments/:id**: Atualiza um comentário específico, pelo ID, do momento ao qual ele pertence.
DELETE
- **/moments/:momentId**: Deleta um momento específico pelo ID.
- **/moments/:momentId/comments/:id**: Deleta um comentário específico, pelo ID, do momento ao qual ele pertence.
❤️🔥 Tecnologias utilizadas
- SQLite
- NodeJs
- AdonisJS
- Git e Github
🤖 Executando a API
Pré-requisito
- [NodeJS LTS](https://nodejs.org/en/)
Passo a passo
```
# Clone este repositório
$ git clone https://github.com/Fel1324/MomentsAPI.git
# Acesse a pasta da API no terminal/cmd
$ cd MomentsAPI
$ cd moments-api
# Instale as dependências da API
$ npm install ou npm i
# Acesse o projeto no editor de código (se achar necessário)
$ code .
# Crie o arquivo .env
$ copie e cole o arquivo .env.example
$ renomeie o novo arquivo para .env e depois o abra
# Gere a APP_KEY
$ node ace generate:key
# Rode as migrações
$ mkdir tmp
$ node ace migration:run
# Execute a API
$ node ace serve
```
> A API irá iniciar na porta 3333
🚧 Status da API
Projeto finalizado ✅
📝 Licença