An open API service indexing awesome lists of open source software.

https://github.com/jasterv/sentences-crud

Nodejs CRUD app using Firebase & Firestore
https://github.com/jasterv/sentences-crud

api-rest crud crud-application crud-sample ejs firebase firestore heroku herokuapp nodejs typescript

Last synced: about 2 months ago
JSON representation

Nodejs CRUD app using Firebase & Firestore

Awesome Lists containing this project

README

          

# ⚠️ This repo has been migrated ⚠️

Mainly for philosofic reasons I've decided to migrate all my projects to a free software alternative forge ([Codeberg](https://codeberg.org/)).

You can find the most recent version of this repository [here](https://codeberg.org/JasterV/sentences-crud).

I encourage any free software activist to follow the same steps, as it doesn't make sense to make use of a propietary software to host our projects if we advocate for free software.

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 ' }`

### 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**

- Github: [@JasterV](https://github.com/JasterV)
- LinkedIn: [@Victor Martinez](https://linkedin.com/in/victor-martinez-montane)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [Victor Martinez](https://github.com/JasterV).
This
project is [MIT](https://mit-license.org/) licensed.

---

_This README was generated with ❤️ by
[readme-md-generator](https://github.com/kefranabg/readme-md-generator)_