Introduction

This section provides an overview of the product.

Hey entrepreneur, welcome to BuilderHack!
Here's a quick overview of the boilerplate. Follow along to get your app up and running.

Getting Started

The repository you got access to follows the NextJS app router structure, so inside the /app directory you have all the main pages and apis already implemented for you:

  • /(site): It's the container for your landing page.

  • /api: All the API routes for your application. Here you'll find the endpoints for your frontend to communicate with the backend. Here you already have webhook for handling Stripe payments, email and retrieve user from supabase.

  • /auth: All the pages API routes for authentication, including sign up, sign in using Supabase Magic Links.

  • /dashboard: The page where you're redirected to once you are signed in. There you can implement internal logic for when the user is authenticated.

  • /docs: Here's the route for you to write documentation for your application. Just like the one you're reading right now. This structure uses the content you provide inside the /content directory, in the root of the project.

  • /licenses: This is a mock for the licences page.

  • /privacy-policy: This is a mock for the privacy policy page.

  • /success-checkout-confirm: This is a mock for the success page after a checkout.

  • /support: This is a mock for the support page.

  • /tac: This is a mock for the terms and conditions page.

It's worth to mention that all the other folder are related to components, helper functions and other utilities that are used throughout the application.

Quick Start

1

Clone the Repository

In your terminal, run the following commands one-by-one:

git clone git@github.com:rafaelpadovani/builderhack.git [YOUR_APP_NAME]
# or if you don't SSH set up use HTTPS
git clone https://github.com/rafaelpadovani/builderhack.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
git remote remove origin
yarn

Note:

Keep in mind that if you choose to clone using HTTPS when Git prompts you for your password please enter your personal access token. More details here in the official docs.

Note:

BuilderHack requires Node 18 or greater. Type node -v in your terminal to check version. This project has been developed and tested using node v19.2.0 and npm 8.19.3, so we highly recommend you to use those.

Now both project have all the necessary dependecies installed!

2

Environment files

The environment you most need to care about is inside /backend.
Rename .env.example to .env.

mv .env.example .env.local

Here we have many keys, don't worry we're gonna go though each of them!

3

Environment files

Open http://localhost:3000 to see your application running!

Before installing our application, make sure you have the following:

Remember:

Node.js installed lets you run JavaScript outside the browser and manage dependencies with npm, essential for frameworks like React and Next.js.

Conclusion

Thank you for choosing the BuilderHack! Now you have the project ready to be configured. In the next session we'll start setting up the environment keys, it's the last step for you to have a project ready to go!