Documentation

Hey Coder, welcome to PullTheCode! 🚀

Here you will find an overview of all the features of PullTheCode. Follow along to get started in minutes!

After you are done, follow this tutorial and your new project will be up and running in no time!

Clone the repo

1. Run the following commands in your terminal

git clone git@github.com:GCinellu/pullthecode.git [YOUR_PROJECT_NAME]
cd [YOUR_PROJECT_NAME]
npm i
git remote remove origin
npm run dev
PullTheCode requires Node 18.17 or greater. Typenode -vin your terminal to check version.

2. Rename.env.sampleto.env

mv .env.sample .env

3. Openhttp://localhost:3000to see your site. And voila!

There might be small errors in the console but don&t worry, I am fixing them in the next steps and they will not prevent you from using PullTheCode.

NextJs Project Structure

  • /src/app→ Pages (1 folder + page.js = 1 page)

  • /src/app/api→ API calls (1 file = 1 API endpoint)

  • /src/components→ React Components

  • /libs→ Libraries Pre-configurations (DB Instance, Auth, etc.)

.env file

After renaming your.env.examplefile to.env.local, you will need to fill in the following variables:

NEXT_PUBLIC_WEBSITE_NAME=YOUR_WEBSITE_NAME
NEXT_PUBLIC_WEBSITE_URL=http://localhost:3000
NEXTAUTH_SECRET=YOUR_SECRET
POSTGRES_PRISMA_URL=file:./dev.db
# ... rest of the file

Now go ahead and followthis tutorialto get your SaaS online in minutes!