Welcome to the Argon project! This guide will walk you through setting up the project on your local development machine.
Before you begin, ensure you have the following:
Start by cloning the repository to your local machine:
git clone https://github.com/srayner/argon.git
Change into the project directory:
cd argon
Install the necessary dependencies by running:
npm install
Create a Database: Log into your MySQL server and create a new database.
Example MySQL command:
CREATE DATABASE argon;
Configure Environment Variables: Create a .env file in the root of your project directory and add your database connection details. Here’s a sample .env file:
DATABASE_URL="mysql://username:password@localhost:3306/argon"
Replace username, password, and argon with your MySQL credentials and database name.
The project uses Prisma for database management. You’ll need to ensure Prisma is set up correctly:
Generate Prisma Client: Run the following command to generate the Prisma client:
npx prisma generate
Migrate Database: Apply any existing migrations to your new database:
npx prisma migrate dev
This will apply the current schema to your database and ensure it's up to date.
Start the development server with:
npm run dev
Open your web browser and navigate to:
http://localhost:3000 You should see the application running locally.
Additional Notes If you encounter any issues during setup, check the logs for errors and ensure all services (like MySQL) are running. For further customization or environment-specific settings, update the .env file accordingly. Enjoy working on Argon!