https://github.com/alejandroq12/rest-api
Rest API created with Node.js + Express.
https://github.com/alejandroq12/rest-api
Last synced: 2 months ago
JSON representation
Rest API created with Node.js + Express.
- Host: GitHub
- URL: https://github.com/alejandroq12/rest-api
- Owner: Alejandroq12
- Created: 2023-09-17T03:02:43.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-10-13T10:44:01.000Z (over 1 year ago)
- Last Synced: 2025-01-08T10:45:51.393Z (4 months ago)
- Language: JavaScript
- Size: 54.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rest-api
Rest API created with Node.js + Express.
Employee Management
# 📗 Table of Contents
- [rest-api](#rest-api)
- [📗 Table of Contents](#-table-of-contents)
- [📖rest-api ](#rest-api-)
- [🛠 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-)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
Rest API...
## 🛠 Built With
HTML,
CSS,
JavaScript.
Client
Package Manager
- **It allows to add, search and list employees.**
- **Fetch data from API to get currency value.**
- It will be available soon.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- `node` should be installed in your local machine, [node website](https://nodejs.org/en/download/).
- Install the `npm` package manager use this [to install both node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
https://github.com/Alejandroq12/employee-management.git
```
- Navigate to the location of the folder in your machine:
**``you@your-Pc-name:~$ cd employee-management``**
### Install
To install all dependencies, run:
```
npm install
```
### Usage
To run the project, follow these instructions(make sure to be in the root folder):
To add an employee:
```
node index.js add
```
To list employees:
```
node index.js list
```
To search by ID:
```
node index.js search-by-id
```
To search by name:
```
node index.js search-by-name
```
### Run tests
To run tests, run the following command:
```
npx eslint .
```
- It will be available in the future. Thank you for your patience.
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
- [ ] **I will allow to erase users.**
- [ ] **I will add validations.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project give me a star ⭐️
-----------
- **Why did you code this project?**
- Because I want to master JavaScript.
This project is [LICENSE](./LICENSE) licensed.