This project is built using a variety of modern web development technologies. Below is a list of the main technologies used in this project:
- Algolia Search
- TypeScript
- Next.js
- Tailwind CSS
- Prisma
- MariaDB
- DDEV
- Docker
Follow these steps to set up and run the project locally:
- Download and Install Docker Desktop: Docker Desktop
- Download and Install DDEV: DDEV
- Create an Algolia Account: Algolia and obtain your API key
-
Clone the Repository:
git clone <repository-url> cd <repository-directory>
-
Edit the
.env.local
and.env
Files:- Copy the
.env.example
file to.env.local
and.env
- Update the database connection string, Algolia API key, and other environment variables as needed
- Copy the
-
Use Node Version Manager (NVM):
nvm use
-
Install Dependencies:
npm install
-
Start DDEV:
ddev start
-
Run Prisma Migrations:
npx prisma migrate dev --name init
-
Generate Prisma Client:
npx prisma generate
-
Seed the Database:
npx prisma db seed
-
Create an Algolia Index:
- Log in to your Algolia account
- Create a new index for your recipes
- Note the index name and update your environment variables accordingly
-
Sync Algolia Index:
npm run syncAlgolia
-
Run the Development Server:
npm run dev
Your project should now be running locally. Open your browser and navigate to http://localhost:3000
to see the application in action.