Kasaija-Kenneth/vanilla-nodejs-rest-api

REST Api built with Vanilla node.js Allows CRUD operations

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [VANILLA NODE.JS REST API]

[ Vanilla Node.js REST API ] Is a simple App with CRUD operations from a .json file.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Server]
• [key_feature_2]
• [key_feature_3]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder e.g my-folder:

  cd my-folder
  git clone git@github.com:Kasaija-Kenneth/vanilla-nodejs-rest-api.git

Install

Install this project with:

  cd vanilla-nodejs-rest-api
  git install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 KASAIJA KENNETH

• Github
• Twitter
• LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [ 1 ] [Read Data]
• [ 2 ] [Create Data]
• [ 3 ] [Update Data]
• [ 4 ] [Delete Data]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

📝 License

This project is MIT licensed.

(back to top)