https://github.com/elyse502/api-simple

Backend NodeJS API with a React client
https://github.com/elyse502/api-simple

api api-client backend express-js js nodejs react react-bootstrap rest restful-api

Last synced: 27 days ago
JSON representation

Backend NodeJS API with a React client

• Host: GitHub
• URL: https://github.com/elyse502/api-simple
• Owner: elyse502
• License: mit
• Created: 2024-07-04T05:40:00.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T06:18:19.000Z (5 months ago)
• Last Synced: 2024-11-06T21:19:40.706Z (3 months ago)
• Topics: api, api-client, backend, express-js, js, nodejs, react, react-bootstrap, rest, restful-api
• Language: JavaScript
• Homepage:
• Size: 418 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  # 👨‍💻 Simple clean nodeJS API 🛜

  A simple clean `REST API built` with `NodeJS`, `express` with a n-tier architecture (organized into layers).





## Setting Up 🏗️

- Make sure you have [NodeJS](https://nodejs.org/en/download) v14 or newer innstalled.

- Run `npm ci` to install all dependencies.

- `npm start` to start your API on port `4000`.

  - You can change the port by editing `src/server.js` and changing `const port = 4000;` to another port number.

- Download [Insomnia](https://insomnia.rest/download) or [Postman](https://www.postman.com/downloads/) to send easily HTTP requests to your API.





## Running unit tests 🛠️

```console

npm test

```

Or with `npx`

```console

npx ava

```





## Running it with Podman ⚓

1. Make sure Podman is correctly installed on your machine - https://podman.io/getting-started/installation

2. From a command line opened , run `podman machine init`, and then `podman machine start`

3. Then, in the project folder (still from your terminal), let's build the image with `podman build -t simple-api-image .`

4. Once it has finished and the image successfully built, you should be able to see it by typing `podman images`

5. Finally, let's run the image container by typing `podman run -p 4000:4000 simple-api-image` - Here, we use port `4000`, and map it to the local port `4000`.





## 3rd-party libraries 🔗

To make our job easier, this API uses the some great handy libraries such as...

* [Pino logging library](https://github.com/pinojs/pino)

* [Yup schema validation](https://github.com/jquense/yup)

* [express-rate-limit](https://github.com/express-rate-limit/express-rate-limit)





## Author :black_nib:

- _[NIYIBIZI Elysée](https://linktr.ee/niyibizi_elysee)👨🏿‍💻 | [Github](https://github.com/elyse502) | [Linkedin](https://www.linkedin.com/in/niyibizi-elys%C3%A9e/) | [Twitter](https://twitter.com/Niyibizi_Elyse)._

[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/niyibizi-elys%C3%A9e/) [![@phenrysay](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/Niyibizi_Elyse) [![pH-7](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/elyse502)





## License 📝

This project is distributed under [MIT license](https://github.com/elyse502/API-SIMPLE/blob/main/LICENSE). Enjoy! 🎉