SaberQuest - Frontend 🖥️

The new frontend for SaberQuest.

Database/Backend 🗄️

• Backend Service

Want to help?

Note

Contributions are always appreciated!

If you want to contribute, fork the repository and make a pull request.
The name of the pull request should be [Username]/[Feature]

Every pull request will be reviewed by a maintainer, and if it is accepted, it will be merged into the next-branch for testing.
If it passes tests and is stable, it will be merged into the main branch, otherwise a maintainer will contact you to fix the issues.

This can take 3-4 days, so please be patient, as We're all working on this in our free time. Thank you!

If you want to contribute to the backend, go to the Backend Repository

Getting Started

First, install the dependencies:

npm install
# or
yarn

Setup the environment variables: .env.example

Warning

If you do not change the secret and salt, the application will use default values. (devsecret and devsalt)
Please change them to avoid cookies being stolen and reversed!

Secrets and salts not changed, is a security risk, and SaberQuest is not responsible for any damage caused by this.

Then, run the development server:

npm run dev
# or
yarn dev

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

Scripts

• dev - Runs 'Prettier' and starts the development server on port 3001.
• build - Builds the application for deployment.
• start - Runs the built application in production mode.
• prod - Runs 'Prettier', builds the application, and runs it in production mode.
• lint - Runs ESLint on the project.
• format - Runs Prettier on the project.

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.

To learn more about Tailwind CSS, take a look at the following resources:

• Tailwind CSS Documentation - learn about Tailwind CSS features and API.
• Tailwind CSS Cheat Sheet - a cheat sheet for Tailwind CSS classes.

To learn more about Flowbite, take a look at the following resources:

• Flowbite Documentation - learn about Flowbite features and API.
• Flowbite Community - a community for Flowbite users.

License 📜

This project is licensed under the Apache-2.0 License - see the LICENSE file for details