Dahlia Parking App

Welcome to the Dahlia parking app project! This app provides an on-demand parking solution for everyday use.

Getting Started

Follow these steps to set up and run the project:

Prerequisites

• Node.js (v14.x or higher)
• npm (v6.x or higher) or yarn (v1.x or higher)
• PostgreSQL (v12 or higher)

Installation

1. Install Root Package

To set up the root package, install dependencies, and configure Husky pre-commit hooks and the Lerna build system:

npm install
# or
yarn install

This will install all necessary dependencies and set up the Husky pre-commit hooks.

2. Frontend Setup

Navigate to './packages/frontend/' directory and install the dependencies

cd ./packages/frontend
npm install
# or
yarn install

To run the development server:

next dev
# or
yarn dev

To run the test scripts:

npm test
# or
yarn test

3. Backend Setup

Navigate to the './packages/backend/' and install dependencies:

cd ./packages/backend
npm install
# or
yarn install

To run development server:

npm start
# or
yarn start

npm test
# or
yarn test

4. Husky Hooks

• In case you are unable to execute Husky hooks:

chmod ug+x .husky/*
chmod ug+x .git/hooks/*

For windows: Windows doesn’t have the chmod command, but you typically don’t need to manually change file permissions. If you encounter issues, try:

git config core.fileMode false

4.2 In case of the warning message "husky - '~/.huskyrc' is DEPRECATED"

For macOS and Linux:

mkdir -p ~/.config/husky
mv ~/.huskyrc ~/.config/husky/init.sh
npm install -g npm

For windows: No equivalent steps are necessary. Ensure your Node.js and npm are up-to-date.

4.3 In case of error message "TypeError: args.at is not a function"

Usually indicates an issue with the compatibility between the Node.js version and the JavaScript code you are trying to run.

Install NVM if you do not have it already: For macOS and Linux:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Install the latest LTS version of Node.js and set the installed version as the default:

nvm install --lts
nvm use --lts
nvm alias default lts/*

For windows: Install NVM for Windows from here and follow the instructions to manage Node.js versions.

Verify the installation:

node -v
npm -v

4.4 Run Hooks Manually

.husky/pre-commit
# or
bash .husky/pre-commit

4.5 For errors related to branch name or commit message format: Please note: We follow a loose convention for branch names

[type]/gh-[issue number]/[summary of task]

gh-16/setup-ci-frontend-tests
docs/gh-16/fix-typos

where 16 is the issue number.

For commit message format checkout - link

Contributing

We welcome contributions to improve this project. Please fork the repository and submit a pull request.

Licensing

This project is licensed under the MIT License.