Skip to content

⏭️ The NextJS evolution of Boklisten.no, the premier high school book platform

License

Notifications You must be signed in to change notification settings

boklisten/bl-next

Repository files navigation

bl-next

bl-next Uptime Robot ratio (30 days) GitHub package.json version License badge

Library and book management services and administration for upper secondary schools. Built with Next.js with Material UI using an express backend. This project is the successor for the bl-web and bl-admin projects, with the aim to unify the administration site with the customer site.

Setup and development

# Install dependencies
$ yarn install

# Copy .env.example to .env and fill in the correct keys to access the required apis

# Run the development server on http://localhost:3000
$ yarn dev

Code style, linting and tests

# Prettier code style
$ yarn prettier

# Linting with Eslint
$ yarn lint

# E2E tests with Cypress
$ yarn cypress run

Branches

There are two active branches, main and develop. You should use develop for all development and treat main as the public live version.

main

This branch should be treated as the production branch and should not have failing code.

When you push code to main the code is also pushed to our production environment on Vercel. Be aware that any commit you push to main will be viewable and executed on our live production server. The main branch is currently running on next.boklisten.no.

develop

This branch should be treated as a development branch, but it does not need to have runnable code. By default, CI will run when pushing to this branch, which is nice for testing your code. To create a production preview, please use the Vercel CLI

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

AGPL-3.0