Side Project Starter Kit

Overview

This repository is designed to be a base project for building side projects in an orderly, scalable manner with the ability to quickly add features. It is based on T3 Stack with some subjective modifications. By cloning the project and configuring the environment variables, users can easily start without any issues.

Features

• Base project: Provides a foundation for side projects.
• Orderly and scalable: Allows for organized and scalable development.
• Quick feature addition: Enables fast addition of new features.

Manual Installation

To execute the project, follow these steps:

1. Clone the repository.
2. Install NPM packages.
3. Configure the environment variables by referring to the .env.example file.
   • If needed, generate a local database using Docker.
   • Update the DATABASE_URL variable in the .env file to point to the local database.
4. To shut down the database, use the appropriate command.

This project uses different .env files based on the app's environment (local, development, production).

Docker Installation

To install using Docker, follow these steps:

1. Clone the repository.
2. Change .env.template to .env.local and update the DATABASE_URL.
3. Execute the provided statement to shut down the application.

Summary

This repository serves as a foundational project for creating side projects in an organized and scalable manner. It allows for quick addition of new features and provides detailed instructions for installation, whether manual or using Docker.