https://github.com/tsheporamantso/peoples-api
API endpoint built with ExpressJS and test using Postman.
https://github.com/tsheporamantso/peoples-api
expressjs node-js postman-api
Last synced: 4 months ago
JSON representation
API endpoint built with ExpressJS and test using Postman.
- Host: GitHub
- URL: https://github.com/tsheporamantso/peoples-api
- Owner: tsheporamantso
- License: mit
- Created: 2024-08-24T06:25:06.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-08-26T10:58:33.000Z (about 1 year ago)
- Last Synced: 2025-01-19T23:33:23.441Z (9 months ago)
- Topics: expressjs, node-js, postman-api
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
API only application 🔗
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**API only application 🔗** This is API only application that stores list of employees with their id numbers.
- **ExpressJS**
- **JSON**
Server
- **Model and Controller**
- **ExpressJS API endpoints**
- [Link](https://github.com/tsheporamantso/hello-react-front-end/pull/1) to Hello-React-Front-End App
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Install nodejs using [link](https://nodejs.org/en/download/prebuilt-installer)
- Install expressjs [link](https://expressjs.com/)
### Setup
Clone this repository to your desired folder:
```sh
mkdir nodejs
cd nodejs
git clone git@github.com:tsheporamantso/peoples-api.git
```
### Install
Install this project with:
```sh
npm install nodemon
```
```sh
npm install express --save
```
### Usage
To run the project, execute the following command:
run the result on the terminal through:
```sh
npm start
```
```sh
https://localhost:8000/
```
### Run tests
To run tests, execute the following command on the terminal
### Deployment
Not deployed
👤 **Gladwin Tshepo Ramantso**
- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)
- [ ] **Populate more data into database**
- [ ] **Add Validations on model**
- [ ] **Persist data on MangoDB**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/tsheporamantso/peoples-api/issues).
If you like this project please give a star on [github](https://github.com/tsheporamantso) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).
I would like to thank:
- [ ] **Microverse and all the staff**
- [ ] **Microverse Communinity**
- [ ] **Thanks to my coding Partners**
- [ ] **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- [ ] **Thanks to Code Reviewers**
This project is [MIT](https://github.com/tsheporamantso/peoples-api/blob/96b830c27867b1beb331a8d345b58bf4251f25e1/LICENSE) licensed.