No description
Find a file
Víctor Martínez 4db83fa4a0
Update README.md
2022-10-16 19:39:20 +02:00
.github/workflows first commit 2021-07-24 01:37:17 +02:00
scripts aggregation script done 2021-07-25 14:55:57 +02:00
src test setup done 2021-07-25 16:15:39 +02:00
test tests done 2021-07-25 17:10:45 +02:00
.env.example firebase.json not required 2021-07-25 04:04:00 +02:00
.eslintrc.json first commit 2021-07-24 01:37:17 +02:00
.gitignore sentences model done 2021-07-24 14:07:44 +02:00
jest.json test setup done 2021-07-25 16:15:39 +02:00
package-lock.json test setup done 2021-07-25 16:15:39 +02:00
package.json test setup done 2021-07-25 16:15:39 +02:00
README.md Update README.md 2022-10-16 19:39:20 +02:00
tsconfig.json backend code done 2021-07-24 16:40:02 +02:00

Sentences CRUD

License: MIT

Nodejs CRUD app using Firebase & Firestore

BUILD

npm run build

RUN

npm run start

DOCS

API Authentication

To make any request to the sentences or translation api you will need to provide an authorization header:

{ 'Authorization': 'Bearer <token>' }

Sentences API

  • Endpoint: https://sentences-crud.herokuapp.com/api/v1/sentences

  • operations:

  • GET /?[lastId=string]&[orderBy=string]&[order='asc' | 'desc']

  • GET /:id

  • POST /:id { text: string, category: string }

  • PUT /:id { text?: string, category?: string }

  • DELETE /:id

Translation API

  • Endpoint: https://sentences-crud.herokuapp.com/api/v1/translate

  • operations:

  • POST / { sentence: string }

Sentences views

You can access the views on https://sentences-crud.herokuapp.com

From this webpage you can perform any operation you can do with the sentences API

Author

👤 Victor Martinez

Show your support

Give a if this project helped you!

📝 License

Copyright © 2021 Victor Martinez.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator