Skip to content

Latest commit

 

History

History
129 lines (87 loc) · 5.78 KB

README.md

File metadata and controls

129 lines (87 loc) · 5.78 KB

Deals for Devs

All Contributors

The best deals and giveaways for developers

Get upcoming and ongoing deals sent straight to your inbox every month!

Getting Started

To get a development environment running on your local machine:

  1. Clone the repository in a directory of your choice.

  2. Create a .env file (from .env.example) and add all the credentials necessary to run the app.

To get those credentials, please send James (@jamesqquick) a message on Discord!

cp .env.example .env
  1. Install packages
npm install
  1. Database Setup You'll need to create a free database with Xata which runs on Postgres. When you create your db, make sure enable the checkbox that says Enable direct access to Postgres.

Since we'll be using Prisma to interact with our database, you need to Enable direct access to Postgres.

Then, select your newly created database. On the next page, you'll want to copy the PostgreSQL endpoint property. Then add this property to your .env file like so.

You'll need to also create an API Key to include in this DB URL. You can do this in your account settings.

DATABASE_URL=<your_postgresql endpoint>

You can click on the Settings tab later on if you ever need to come back to these settings.

Now, you'll need to push the Prisma schema to your db. In your terminal, run the following command. This will generated the necessary tables.

npx prisma db push

You should be able to verify the tables were created successfully inside of the Xata dashboard.

Lastly, you'll need to generate the Xata configuration and typings in your project.

Login to your Xata account. This will pop open a new browser window to handle authentication.

xata auth login

Initialize xata in your project directory.

xata init

Choose the database and the default settings from there.

  1. Run the development server.
npm run dev
# or
yarn dev
# or
pnpm dev

Tech Stack

Contributing

You are welcome to contribute by opening issues or PRs!

Be sure to check out our Contribution Guide. Also, you can join our project channel on the Learn Build Teach Discord by messaging James (@jamesqquick) on Discord for access.

Important

All PRs should target dev as the base branch.

Contributors

Chris Nowicki
Chris Nowicki

💻
Waseem Medhat
Waseem Medhat

💻
klae32
klae32

💻
Edwin Boon
Edwin Boon

💻
Bryan Fines
Bryan Fines

📖
Ellie
Ellie

💻
Christine Belzie
Christine Belzie

💻 📖 ️️️️♿️