Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakhawat71/university-management-backend
University Management
https://github.com/sakhawat71/university-management-backend
expressjs mongo mongoose nodejs typescript
Last synced: 12 days ago
JSON representation
University Management
- Host: GitHub
- URL: https://github.com/sakhawat71/university-management-backend
- Owner: Sakhawat71
- Created: 2024-11-26T13:42:04.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-18T19:40:03.000Z (14 days ago)
- Last Synced: 2025-01-18T20:29:38.291Z (14 days ago)
- Topics: expressjs, mongo, mongoose, nodejs, typescript
- Language: TypeScript
- Homepage: https://ph-university-71.vercel.app/
- Size: 1.67 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# University Management Backend
This project is a backend system for managing university operations. It provides APIs for handling various aspects of university management, including student enrollment, course management, and faculty administration.
## Live Link
You can access the live version of the University Management Backend at the following URL:
[Live Demo](https://ph-university-71.vercel.app)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Installation
To get started with the project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/sakhawat71/university-management-backend.git
```
2. Navigate to the project directory:
```bash
cd university-management-backend
```
3. Install the dependencies:
```bash
npm install
```
4. Set up the environment variables by creating a `.env` file in the root directory and adding the necessary configuration.
5. Start the development server:
```bash
npm start
```
## Usage
Once the server is running, you can access the API endpoints using a tool like Postman or cURL. The base URL for the API is `http://localhost:3000`.
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request to the main repository.