Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amitkumaurya/brewapps-backend-app
This is a book store application.
https://github.com/amitkumaurya/brewapps-backend-app
cyclic-deployment express joi-validation mongodb mongodb-atlas mongoose nodejs
Last synced: 6 days ago
JSON representation
This is a book store application.
- Host: GitHub
- URL: https://github.com/amitkumaurya/brewapps-backend-app
- Owner: AmitKuMaurya
- Created: 2023-10-30T07:17:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-30T23:06:07.000Z (about 1 year ago)
- Last Synced: 2024-11-09T03:14:27.462Z (2 months ago)
- Topics: cyclic-deployment, express, joi-validation, mongodb, mongodb-atlas, mongoose, nodejs
- Language: TypeScript
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# This is a bookstore application.
# Technologies
- Node Js
- Express Js
- MongoDB
- Mongoose
- Mongo Atlas
- Joi
- Cyclic Hosting
## API References
- To run this project via deployed Link. use the below steps.
- Deployed URL
```http
https://brewapps-backend.cyclic.app
```
### Get all books
```http
GET https://brewapps-backend.cyclic.app/API/v1/books
```
#### You will get all the books listing
### Get a single book
```http
GET https://brewapps-backend.cyclic.app/api/v1/book/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :----------------------------------- |
| `id` | `string` | **Required**. Id of product to fetch |
### Add A New Book
```http
POST https://brewapps-backend.cyclic.app//api/v1/book-create
```
| Parameter | Type | Description |
| :------------- | :------- | :---------------------------------------------------- |
| `title` | `string` | **Required**. book title |
| `author` | `string` | **Required**. book author |
| `description` | `string` | **Required**. book description |
### Update book
```http
PATCH https://brewapps-backend.cyclic.app/api/v1/book-update/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------------- |
| `id` | `string` | **Required**. Id of a book to update |
### Delete book
```http
DELETE https://brewapps-backend.cyclic.app/api/v1/book-delete/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------------- |
| `id` | `string` | **Required**. Id of a book to delete |
- To run this project, you will need not to add any environment variables to your .env everything is already added. follow the steps to mentioned below to run locally
# Run through local system
Clone the project
```bash
https://github.com/AmitKuMaurya/BrewApps-backend-app.git
```
Go to the project directory
```bash
cd BrewApps-backend-app
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
- Please use the routes and parameters mentioned above on port - 5050 and replace this domain `https://brewapps-backend.cyclic.app` with this `http://localhost:5050/api/v1/books` only.
-- now all the steps are the same as mentioned above from line no.21.
## Status
- These both will ensure that the application is running perfectly.
```
{ msg: 'DataBase Connected Successfully 🌼' }
{ msg: 'Server is Listing on Port 5050 🤙' }
```
- Thanks For Visiting Here