Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pushpendra-1697/school-listing
This project will deliver a comprehensive e-commerce API set that enables seamless school listing. The integration of MongoDB as the database and token management system ensures efficient data storage and user authentication with minimal server-side setup.
https://github.com/pushpendra-1697/school-listing
bson cloudinary component cors dotenv expressjs fetch-api form-validation form-validation-js html-css-javascript inter-font mongodb mongoosejs multer nextjs nodejs nodemon schema-model thunder-client
Last synced: 6 days ago
JSON representation
This project will deliver a comprehensive e-commerce API set that enables seamless school listing. The integration of MongoDB as the database and token management system ensures efficient data storage and user authentication with minimal server-side setup.
- Host: GitHub
- URL: https://github.com/pushpendra-1697/school-listing
- Owner: Pushpendra-1697
- Created: 2024-01-31T16:02:26.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-02-03T20:48:39.000Z (8 months ago)
- Last Synced: 2024-09-27T20:40:16.466Z (6 days ago)
- Topics: bson, cloudinary, component, cors, dotenv, expressjs, fetch-api, form-validation, form-validation-js, html-css-javascript, inter-font, mongodb, mongoosejs, multer, nextjs, nodejs, nodemon, schema-model, thunder-client
- Language: JavaScript
- Homepage: https://school-listing.vercel.app/
- Size: 1.24 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# School-Listing
# Overview For Backend
This project will deliver a comprehensive e-commerce API set that enables seamless school listing. The integration of MongoDB as the database and token management system ensures efficient data storage and user authentication with minimal server-side setup.
## Live/deploy link on the render
```bash
https://school-listing-server.onrender.com/
```
## Installation & Tech Stack
Clone the Repository from GitHub. Then do the following steps:
```bash
npm init -y
npm i express mongoose cors dotenv nodemon multer cloudinary
```
## To run server (PORT = 8000)
```bash
npm run server
```
## Some HTTP (Hyper Text Transfer Protocol) Status Code Which I used :
200 ---> OK/Success/get/put
201 ---> Created/post
202 ----> Delete Successfully
204 ----> Delete Failure
404 ---> Not Found/failure
### NOTE: Used Timestamps & Date datatypes which allow by BSON.
## Database Name:
```bash
school-list
```
## Schema
#### 1) *School*:
Collection Name: schools
- name --> String
- image --> String
- address --> String
- city --> String
- state --> String
- phone --> Number
- email --> String
## NOTE: I used Thunder Client Extension for testing all REST APIs.
### Routes / End Points tested by Thunder Client Extension :
#### 1. */school/store*: (POST)
##### Output: Success Message and data will store in MongoDB
#### 2. */school/upload*: (POST)
Using for upload the school image into schoolImages directory
##### Output: Success Message
#### 3) */school/get*: (GET)
##### Output: Retrieves all schools
# Overview For Frontend
## Live/deploy link on the Vercel
```bash
https://school-listing.vercel.app/
```
## Installation & Tech Stack
Clone the Repository from GitHub. Then do the following steps:
```bash
npm install
```
## To run server (PORT = 3000)
```bash
npm run dev
```
## Form Validation
### For Phone No Field
Should be 10 digit
### For Email Field
should contain '@'
# Some Screenshots for different screens
