https://github.com/sharadcodes/rcc-rest-api-bootcamp
https://github.com/sharadcodes/rcc-rest-api-bootcamp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sharadcodes/rcc-rest-api-bootcamp
- Owner: sharadcodes
- Created: 2023-08-26T09:49:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T18:19:36.000Z (over 2 years ago)
- Last Synced: 2025-01-18T08:22:55.470Z (12 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RCC (Restful CRUD API with Express)
## Installation
To get started you'll need to have Node.js and npm (Node Package Manager) installed on your system. If you haven't already, you can download and install them from [Node.js official website](https://nodejs.org/).
Once you have Node.js and npm installed, follow these steps to set up RCC:
1. Clone or download the RCC repository to your local machine.
2. Open your terminal and navigate to the project's root directory.
3. Run the following command to install the project's dependencies:
```bash
npm install
```
## Usage
Here's how to use this Express.js API:
- **Root Route**: When you access the root route (http://localhost:3000/), it will respond with "Pranam! 🙏🏻".
- **Students Route**: You can access student-related routes by going to paths starting with "/students". Please make sure to define your specific student routes in a separate `student.js` file and import them into `app.js`.
- **Middleware**: This application uses two middleware components:
- `express.json()`: Parses incoming JSON requests.
- `morgan("dev")`: Logs HTTP requests to the console.
- **Starting the Server**: To start the server, run the following command:
```bash
npm start
```