A University Admin Application

An app that allows a university admin to pick a course for students and so much more

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Installation using Docker
3. Usage
4. License

About The Project

Imagine an Admin for a university who wants to manage student course enrollment and unenrollement for a school session seamlessly, COSPIK is the right solution for you, it offers the following functionality:

Features

• An admin can signup and login
• List of students can be seen in a paginated table
• New students can be added
• Student name can be edited
• Available courses can be viewed in a paginated table
• New courses can be added to the app
• Courses can be deleted from the app
• A student information showing their enrolled courses can be viewed
• Admin can enroll(add) and unenroll(remove) student for a course

Built With

• Typescript
• NodeJs
• ExpressJs
• ReactJs
• Redux
• React-Bootstrap
• Jest
• PostgreSql

Getting Started

Installation using Docker

• Install Nodejs
• Install Docker if you don't have it installed on your system
• Clone this repo

    git clone https://github.com/d-beloved/cospik

• check the .env-sample files inside /server folder and on the root of the app, fill the information as required
• When running the app for the first time, run

    docker-compose up --build

  to build the images and start the container; for subsequent runs, you need to remove the --build flag

Usage

Please refer to the Documentation for information on the available APIs

License

Distributed under the MIT License. See MIT License for more information.

© Ayodeji Moronkeji