Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fahimahammed/academic-administration-solution-server

This repository hosts the backend server for our Academic Administration Solution, a comprehensive system designed to optimize administrative workflows, foster effective communication, and support seamless academic operations for students, faculty, and administrators.
https://github.com/fahimahammed/academic-administration-solution-server

expressjs nodejs postgresql prisma-orm typescript ums

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/fahimahammed/academic-administration-solution-server
Owner: fahimahammed
License: mit
Created: 2023-09-20T09:31:18.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-30T19:36:52.000Z (3 months ago)
Last Synced: 2024-10-30T20:29:27.756Z (3 months ago)
Topics: expressjs, nodejs, postgresql, prisma-orm, typescript, ums
Language: TypeScript
Homepage:
Size: 263 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Academic Administration Solution

[![Server](https://img.shields.io/badge/Server-Yes-brightgreen)](https://github.com/fahimahammed/academic-administration-solution-server) [![Version](https://img.shields.io/badge/Version-1.0-blue)](https://github.com/fahimahammed/academic-administration-solution-server) [![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen)](https://github.com/fahimahammed/academic-administration-solution-server) [![PostMan Documentation](https://img.shields.io/badge/Documentation-Link-blue)](https://documenter.getpostman.com/view/3910568/2s93ecvq6w) [![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)

Welcome to the Academic Administration Solution server repository! This server is an integral part of our university management system designed to streamline administrative processes, enhance communication, and facilitate academic operations for students, faculty, and administrators.

## Getting Started

To set up the server locally, follow these steps:

1. **Clone the Repository:**
```bash
git clone https://github.com/fahimahammed/academic-administration-solution-server.git
```

2. **Install Dependencies:**
```
cd academic-administration-server
yarn install
```

3. **Configure Environment Variables:**
- Create a `.env` file in the root directory.
- Define the following environment variables:
```
NODE_ENV=development
PORT=
DATABASE_URL=
USER_DEFAULT_PASS =
JWT_SECRET=
JWT_EXPIRES_IN=
JWT_REFRESH_SECRET=
JWT_REFRESH_EXPIRES_IN=
PASS_RESET_TOKEN_EXPIRES_IN=
CLOUD_NAME=
API_KEY=
API_SECRET=
FORGOT_PASS_RESET_LINK=
EMAIL=
APP_PASS=
STORE_ID=
STORE_PASSWORD=
PAYMENT_API=
VALIDATION_API=
SUCCESS_URL=
CANCEL_URL=
FAILED_URL=
```

4. **Database Setup:**
- Ensure that you have a compatible database system (e.g., PostgreSQL) installed and running.
- Update the `DATABASE_URL` variable in `.env` with your database connection string.

5. **Run the Server:**
```
yarn dev
```

## Technology Stack

- **Prisma ORM:** Modern database toolkit for TypeScript and Node.js.
- **TypeScript:** Typed superset of JavaScript that compiles to plain JavaScript.
- **JWT:** Secure method for authentication and generating access tokens.
- **Node.js:** Server-side JavaScript runtime.
- **Express.js:** Web application framework for Node.js.
- **Node Mailer:** Module for sending emails from Node.js applications.
- **Cloudinary:** Cloud-based image and video management platform.
- **bcrypt:** Password hashing library for securing user credentials.
- **Multer:** Middleware for handling multipart/form-data for file uploads.

## ERD
![ERD](https://i.ibb.co/XWT2jXZ/AAS-ERD.png)

## Contributors
- Fahim Ahammed Firoz