Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
OsamaAsim6876872-Backend/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
40 lines (30 sloc)
1.12 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Yummy API | |
<p align="center"> | |
<img src="https://img.shields.io/badge/Nodejs-10.12.0-blue.svg?colorB=90c53f"> | |
<img src="https://img.shields.io/badge/Express-4.16.4-blue.svg?colorB=47535e"> | |
<img src="https://img.shields.io/badge/SQL-4.0.1-blue.svg?colorB=764abc"> | |
<br/> | |
</p> | |
## [Documentation](https://documenter.getpostman.com/view/6192445/Rzn8PMEx) | |
API documentation can be found on the above link. | |
## Overview | |
This repository contains a Server hosting API for the Yummy food blog. This is a full restful API allowing CRUD operation like Registering a new user, Returning user data, Editing and deleting user data. All the user data is stored in a SQL database. The API is built on the express framework and utilizes various node modules. | |
#### Using | |
- Nodejs | |
* Express CORS Middleware | |
* Nodemon - for watching for server changes | |
-SQLite3 | |
## Getting started | |
#### Requirements | |
- Node.js | |
- NPM | |
### Package installation | |
Execute the following command on your terminal to install all the needed packages: | |
``` bash | |
npm install | |
``` | |
### Start the Server | |
Execute the following command to start the server: | |
``` bash | |
node index.js | |
``` |