Alamin02/openclass

Open-source learning management system

Getting Started

To install the dependencies:

yarn install
# or simply 
yarn

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Setup database

The database can run on docker or locally. To use the docker you need docker installed on your machine.

# start
docker-compose up --build

# close 
docker-compose down

To run migrations to your database:

yarn db:migration:run

To create new migrations automatically when you create or update entities:

yarn db:migration:generate -n [MIGRATION_NAME]

To generate template for manual migrations:

yarn db:migration:create -n [MIGRATION_NAME]

Refer to typeorm documentation to learn more about migrations.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.