Lucky Parking

A Hack for LA project to help city planners and the community make informed decisions about parking politices in the City of Los Angeles.

Prerequisites

• Install Node.js 18.
• Install pnpm.
• Fork the repository: https://github.com/hackforla/lucky-parking/fork.
• Clone your fork to your computer for local development.
• Add remote to this repository:

git remote add upstream [email protected]:hackforla/lucky-parking.git

Scripts

In the project directory, you can run the following:

pnpm install

Installs all dependencies defined in package.json. This step is required before running the project locally.

To install a new dependency, run pnpm install -w <package>.

To install a new dev dependency, run pnpm install -wD <package>'.

pnpm run clean

Deletes any build artifacts and dependencies from the workspace and packages. You will need to re-execute pnpm install to run the project locally.

pnpx nx dev @lucky-parking/website

Runs the website app in development mode. Open http://localhost:5173/ in your browser to view the client application.

pnpx nx dev @lucky-parking/api-express

Runs the express server in development mode at http://localhost:3000/.

pnpx nx storybook @lucky-parking/ui

Runs the Storybook instance of the UI library. Open http://localhost:6006/ in your browser to explore the UI library.

Contributing

Contributions are always welcome!

To get started, following our organization onboarding steps, and as always, please adhere to Hack for LA's Code of Conduct.