-
Notifications
You must be signed in to change notification settings - Fork 0
Local Development Setup
Jay Mathukiya edited this page Apr 14, 2025
·
1 revision
Follow these steps to set up the SoloType project for development on your local machine.
- Git: Download Git
- Node.js: v18 or v20 recommended (Download Node.js)
- npm: Included with Node.js
- (Optional) Docker: Recommended for running the containerized version locally (Download Docker)
-
Clone the Repository:
git clone [https://github.com/jay-021/SoloType.git](https://github.com/jay-021/SoloType.git) cd SoloType -
Install Dependencies:
npm install
-
Configure Environment Variables:
- Create a file named
.env.localin the root of the project (SoloType/). - Copy the contents of
.env.example(if it exists) or add the following variables, replacing the placeholder values with credentials from your own Firebase project:NEXT_PUBLIC_FIREBASE_API_KEY=YOUR_API_KEY NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=YOUR_AUTH_DOMAIN NEXT_PUBLIC_FIREBASE_PROJECT_ID=YOUR_PROJECT_ID NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=YOUR_STORAGE_BUCKET NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=YOUR_MESSAGING_SENDER_ID NEXT_PUBLIC_FIREBASE_APP_ID=YOUR_APP_ID
- (Note: You need to create a Firebase project and register a Web App to get these values - see Firebase Authentication Setup for more context).
- Create a file named
-
Run the Development Server:
npm run dev
- The application should now be running at
http://localhost:3000.
- The application should now be running at
-
Build the Docker Image: (Make sure Docker Desktop is running)
docker build -t solotype-frontend . -
Run the Docker Container:
# Ensure your .env.local file exists in the project root docker run -p 3000:3000 --env-file .env.local solotype-frontend- The application should be accessible at
http://localhost:3000.
- The application should be accessible at