Introduction

​

Setting up

Get started with shipit is really simple, just follow these steps:

​

1. Clone the repository

Open a terminal and run the following command:

git clone https://github.com/manumrtf/shipit

​

2. Install dependencies

cd shipit
npm install

​

3. Fill the environment variables

Create a .env file in the root of the proyect and copy-paste the content from the .env.example file. The file will look like this:

DATABASE_URL="file:./dev.sqlite"
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
RESEND_API_KEY=""
NEXT_PUBLIC_CRISP_WEBSITE_ID=""
STRIPE_SECRET_KEY=""
STRIPE_WEBHOOK_SECRET=""
EMAIL_FROM=""
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="changethisonproduction"
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=""

If you need help to fill the environment variables, please refer to the Environment Variables documentation.

​

4. Fill the database

For a quick development, shipit use sqlite as database by default. To fill the database with the neccesary tables, run the following command:

npx prisma db push
npx prisma generate

​

5. Start the development server

npm run dev

​

6. Start receiving payments

To configure your products/subscriptions, checkout the Payments Guide.

​

Guides

This other guides may also be useful for you now: