Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 1.79 KB

README.md

File metadata and controls

86 lines (54 loc) · 1.79 KB

Opal

Build Status

NextJS Web App for the Badge Platform for CeSIUM's Computer Engineering Week event.

This is a collaborative project alongside the Safira backend platform and the nativemoon mobile app.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installing

Installing npm dependecies.

npm install

Development

Starting the development server.

npm run dev

Format the code accordingly to common guide lines.

npm run format

Lint your code with eslint.

npm run lint

Deployment

Builds and exports the app for production.

npm run deploy

Usage

Sign-up

The sign-up page is intended to be accessed exclusively by users who have received a custom sign-up link in their emails.

For development purposes, you can craft a sign-up link by following the template:

    YOUR_DOMAIN/signup?id=SAFIRA_UUID

Contributing

Please read CONTRIBUTING and CODE_OF_CONDUCT for details on our code of conduct and the process for submitting pull requests to us.

License

Copyright (c) 2019-2022, CeSIUM.

This project is licensed under the MIT License - see the LICENSE file for details.