diff options
| author | Karan Jayachandra <mail@karanjayachandra.com> | 2026-08-30 22:43:21 +0200 |
|---|---|---|
| committer | Karan Jayachandra <mail@karanjayachandra.com> | 2026-08-30 22:43:21 +0200 |
| commit | fc8d8ab8d0da95ec79056f59e14a150df6fcea89 (patch) | |
| tree | 33f8050b2f2920c0f1b884a205a8aa4c81d7687c /CONTRIBUTING.md | |
| parent | d37ebfda883bcd03b146a85bc3e5a4657d0abd73 (diff) | |
Moved to sveltemain
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c15148..a1f39c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ # Contributing -To contribute you need to have [git](https://git-scm.com/) and [UV](https://docs.astral.sh/uv/) setup. +To contribute you need [git](https://git-scm.com/) and [Node.js](https://nodejs.org/) set up. ## Setup -Set up the repository via a git clone and setup a new branch using the following commands: +Set up the repository via a git clone and set up a new branch using the following commands: ```bash git clone git@gitlab.com:KaranJayachandra/match_up.git @@ -14,21 +14,26 @@ git branch <branch-name> git checkout <branch-name> ``` -Now we can install the dependencies using: +Now install the dependencies: ```bash -uv sync +npm install ``` -A database URI needs to be added to let the application know where to create a test database by creating a `.flaskenv` file in the root directory containing the variable `SQLALCHEMY_DATABASE_URI=sqlite:///app.db`. Now, we need to initialize a database for testing via the following commands: +Start the dev server: ```bash -uv run flask init -uv run flask migrate +npm run dev ``` -We are now ready to run the flask application using: +Run the test suite: ```bash -uv run flask run +npm run test +``` + +Build a production bundle (output goes to `dist/`): + +```bash +npm run build ``` |
