indie-creator-community / side-project-starter-kit Goto Github PK

Getting Started

This repository was created with the intention that it can serve as a base project, oriented to the creation of Side Projects that need to be built in an orderly, scalable and above all that allows to add features quickly.

It is based on T3 Stack with a few very subjective modifications.

Simply cloning the project, and configuring the environment variables, you should be able to start without any problem.

More details here: https://twitter.com/serudda/status/1653172466725064705?s=20

Installation

Manual Installation

Here are the steps to execute the project:

1. Clone the repo

   git clone https://github.com/Indie-Creator-Community/side-project-starter-kit.git

2. Install NPM packages

   pnpm install

3. You will find an .env.example file, where you will see the basic variables for the project to work.

   DISCORD_CLIENT_ID= 'ENTER YOUR CLIENT ID';

   4.1 (Optional) Generate Local Database Before proceeding, please ensure that Docker is installed and docker's daemon is running on your system. If you don't have Docker, you will need to install it.

   To generate a local database, execute the following command:

   pnpm db:docker:startup
   

   This command will create a local database using Docker. Please note that you will need to modify the DATABASE_URL variable in your .env.* file to point to this local database.

   If you need to shut down the database at any time, you can do so by executing the following command:

   pnpm db:docker:shutdown
   

   This will safely shut down the Docker database. Remember to update your DATABASE_URL if you switch back to another database.

4. This project uses an .env file depending on the environment in which the app is running.

   local: .env.local development: .env.development production: .env.production

5. To make a build of all apps and packages

   pnpm build

6. Run the apps/nextjs

   pnpm dev

(back to top)

Docker Installation

1. Clone the repo

   git clone https://github.com/Indie-Creator-Community/side-project-starter-kit.git

2. Change .env.template to .env.local and change the DATABASE_URL

   DATABASE_URL="postgresql://root:admin@postgres:5432/started-db?schema=public"

3. execute the following statement

   pnpm app:docker:startup

4. to shut down the application

   pnpm app:docker:shutdown