Web

MellonPass web application.

Table of Contents

• Getting Started
• Scripts
• Deployment
• Contributing
• License

Getting started

Prerequisites

Make sure you have the following installed on your machine:

• node (>= 18.x)
• npm (>= 9.x)

Installation

1. Cloning the repository:

   git clone [email protected]:mellonpass/web.git
   

2. Installing dependencies:

   npm i --only=dev
   

Running the application

1. Setup local environment variables.

   touch .env.example .env
   

2. Starting the development server:

   npm run dev
   

Scripts

The following scripts are available in the package.json:

• npm run dev: Start the development web server.
• npm run check:watch: Start the realtime svelte-check diagnostics.
• npm run build: To build production readt distibution.

Contributing

To contribute, follow these steps:

• Fork the repository.
• Create a new branch (git checkout -b feat/your-feature).
• Make your changes.
• Commit your changes. See conventional-commits for composing commit messages.
• Push to the branch (git push origin feat/your-feature).
• Open a pull request.

License

This project is licensed under the GPL v3 License. See the LICENSE file for details.