Getting Started #

This section will help you build a basic Corrad application.

Prerequisites #

Before you begin, make sure you have the following installed:

• Node.js
• Yarn
• Git

Installation #

To install Corrad, run the following command in your terminal:

mkdir corrad-app

This will create a new directory called corrad-app in your current directory. Clone the repository to your local machine:

git clone https://github.com/corrad-software/corrad

Before you can run the application, you need to install the dependencies. To do so, run the following command in your terminal:

yarn install

Configuration #

Before you can run the application, you need to configure the database connection. To do so, open the .env file in your text editor and update the following values:

DATABASE_URL="mysql://root:password@localhost:3306/corrad"
ACCESS_TOKEN_SECRET="secret"
REFRESH_TOKEN_SECRET="secret"

Database Migration #

Before you can run the application, you need to migrate the database. To do so, run the following command in your terminal:

yarn prisma migrate dev

This will create the database and tables needed for the application to run. You can find more information about database migration here.

Running the Application #

To run the application, run the following command in your terminal:

yarn dev

This will start the application on port 3000. You can access the application by visiting port 3000.

Next Steps #

Now that you have a basic Corrad application running, you can start building your application. To learn more about Corrad, check out the next section.