Skip to content

Gichbuoy/RESTful_API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

49a4a68 · Feb 29, 2024

History

86 Commits
Feb 29, 2024
Feb 29, 2024
Oct 31, 2023
Oct 24, 2023
Feb 29, 2024
Nov 20, 2023

Repository files navigation

RESTFul Backend Node.js API with React Client

Overview

  • This project involves the development of a backend API using Node.js along with a frontend React client.

  • Read the blog about this project on Medium

  • The API will be plugged to our frontend client, that will speak to the API through HTTP protocol.

Technologies Used

  • Node.js
  • React
  • Bootstrap

Features

Backend

  • Communicate with the backend. HTTP methods and codes.

  • Request API endpoints

  • Calling the CRUD(Create-Read-Update-Delete) endpoints from the client.

  • Validate the input data validation with yup schema validation. (yup schema validator validates input received from body of API)

  • Helmet package to improve the security of API by setting HTTP response headers.

  • Using API documentation generator JSDoc to add documentation to functions.

Frontend

  • Designed the frontend with reusable components.

  • Styled-components

  • Addition of pages using React-Router-Dom

  • Created Users

post request

  • Edit User

post request

Contributing

Contributions to the project are welcome! If you would like to contribute, please follow these guidelines:

  • Fork the repository and clone it locally.

  • Create a new branch for your feature or bug fix.

  • Make your changes and test thoroughly.

  • Commit your changes with clear and descriptive commit messages.

  • Push your branch to your forked repository.

  • Create a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License

Acknowledgements

I would like to acknowledge Wellington-Mwadali for working on the frontend part of this project.