Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nazmul-nhb/university-management-server
University Management Server with Persian Bhai
https://github.com/nazmul-nhb/university-management-server
bcrypt express mongodb mongoose typescript university
Last synced: 18 days ago
JSON representation
University Management Server with Persian Bhai
- Host: GitHub
- URL: https://github.com/nazmul-nhb/university-management-server
- Owner: nazmul-nhb
- Created: 2024-11-27T13:41:54.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-29T16:21:43.000Z (about 2 months ago)
- Last Synced: 2024-12-29T17:25:13.574Z (about 2 months ago)
- Topics: bcrypt, express, mongodb, mongoose, typescript, university
- Language: TypeScript
- Homepage: https://university-management-server-nhb.vercel.app
- Size: 290 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# University Management Server with Persian Bhai
- [Live Server Link](https://university-management-server-nhb.vercel.app)
## Technologies (Packages) Used
- `TypeScript`
- `Node.js`
- `Express.js`
- `Mongoose`
- `cors`
- `dotenv`
- `bcrypt`
- `jsonwebtoken`
- `chalk`
- `progress-indicator`
- `execa`
## Run the Server Locally
### Prerequisites
- Node.js (v20+)
- `pnpm` package manager
- If you prefer `npm` or `yarn`, delete `pnpm-lock.yaml` file and follow the following steps
### Installation
1. Clone the repository:
```bash
git clone https://github.com/nazmul-nhb/university-management-server.git
cd university-management-server
```
2. Install dependencies:
```bash
pnpm install
```
for `npm`:
```bash
npm install
```
for `yarn`:
```bash
yarn install
```
3. Set up environment variables:
Create a `.env` file in the root directory with the following fields:
```env
PORT=4242
MONGO_URI=your_mongo_db_uri
```
4. Start the server:
```bash
pnpm start
```
for `npm`:
```bash
npm start
```
for `yarn`:
```bash
yarn start
```
5. Access the API at:
```bash
http://localhost:4242
```
---
## API Documentation
### Base URL
`http://localhost:4242`
### Endpoints
---
## Error Responses
All error responses follow this structured format:
```json
{
"success": false,
"message": "Short error message",
"errorSources": [
"path": "Where error occurred",
"message": "Exact error message"
],
"stack": "Error stack if available..." // Only in development mode
}
```