elliotBraem/nearn

NEARN

An open source platform connecting founders with elite talent to create bounties and accelerate project completion

Development Setup

Prerequisites

NodeJS
MySQL
pnpm

Getting Started

Clone the repository into a public Github repository (or fork it):
```
git clone https://github.com/NEAR-DevHub/nearn.git
```
Navigate to the project directory:
```
cd nearn
```
Install the dependencies:
```
pnpm i
```
Set up your .env file.

Start by copying the .env.example file to a new file named .env. This file will store your local environment settings.
Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.
Database setup
- Set the DATABASE_URL environment variable with your MySQL connection string. Services like railway.app or Render can help you host a database if you don't run one locally.
```
DATABASE_URL='mysql://<user>:<pass>@<db-host>:<db-port>/<database>?sslaccept=strict'
```
- Generate prisma migrations & client.
```
npx prisma migrate dev --name init && npx prisma generate
```
You have to set up resend to run the app:
- Resend: To obtain your RESEND_API_KEY, visit the Resend dashboard. This credential is essential for setting up Email Auth.

NOTE: If you are facing any issues with setup, please create an issue and we will try to help you out.

Run the development server
```
pnpm dev
```

Contributing

We welcome contributions from everyone! Whether it's submitting an issue, a pull request, or suggesting new ideas, your input is highly valued. Check out our contributing guide for guidelines on how to proceed.