This README will guide you through setting up your development environment and getting started with developing Pedals.
- Ensure you have Node.js installed on your machine.
We recommend using Visual Studio Code along with the following extensions for this project:
./vscode/settings.json has been configured to ensure these extensions work seamlessly together. ESLint will catch and warn about all style errors, and Prettier will format your code on save. Make sure to use Prettier as your default formatter in user settings.
To install and start developing, follow these steps:
-
Clone the repository:
git clone <repository-url>
-
Navigate to the source directory:
cd ./src -
Add the local enviornment variables in an .env.local with this format:
NEXT_PUBLIC_SUPABASE_URL=<YOUR SUPABASE URL>
NEXT_PUBLIC_SUPABASE_KEY=<YOUR SUPABASE ANON KEY>- Install the dependencies using npm or other package managers:
npm ci
Now you are ready to start developing!
First, run the development server:
npm run dev(Or the equivalent for other package managers)
Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.