Development

Prerequisites: - Node.js (version specified in .nvmrc) - pnpm

Local Development

Follow these steps to set up and run Tutly documentation locally:

Step 1: Clone the Repository

git clone https://github.com/yourusername/tutly.git
cd tutly

Step 2: Set Up Development Environment

Run the following command to set up your development environment:

make up

This will:

Copy the example environment file to .env
Install all dependencies
Set up local Docker services
Initialize the database schema
Load initial dummy data

Step 3: Start Development Server

make dev

The development server will be running at http://localhost:3000

Useful Commands

# Start the development server
make dev

# Open Prisma Studio for database management
make studio

# Stop all services
make down

# Clean all services, volumes, and .env
make clean

# Re-initialize the project (after cleaning)
make init

Project Structure

.github
  └─ workflows
        └─ CI with pnpm cache setup
.vscode
  └─ Recommended extensions and settings for VSCode users
apps
  ├─ web
  ├─ api
  └─ docs
packages
  ├─ auth
  ├─ db
  ├─ ui
  └─ validators
tooling
  ├─ eslint
  ├─ prettier
  ├─ tailwind
  └─ typescript

Code Formatting

We recommend using the following VSCode extensions for development:

MDX VSCode extension for syntax highlighting
Prettier for code formatting

Troubleshooting

Error: Could not load the 'sharp' module

This may be due to an outdated version of Node.js. Try the following:

Check your Node.js version matches the one in .nvmrc
Run make clean to clean the environment
Run make up to reinitialize the project

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details. Key points of the license:

You are free to use and modify the software for personal use
Distribution of the software is not permitted
You must preserve the license and copyright notices
You must state significant changes made to the code
The license applies to the entire work, including all its parts

For more information about the license, visit https://www.gnu.org/licenses/agpl-3.0.html

Getting Started

Core Features

Local Development

Step 1: Clone the Repository

Step 2: Set Up Development Environment

Step 3: Start Development Server

Useful Commands

Project Structure

Code Formatting

Troubleshooting

License

​Local Development

​Step 1: Clone the Repository

​Step 2: Set Up Development Environment

​Step 3: Start Development Server

​Useful Commands

​Project Structure

​Code Formatting

​Troubleshooting

​License

Local Development

Step 1: Clone the Repository

Step 2: Set Up Development Environment

Step 3: Start Development Server

Useful Commands

Project Structure

Code Formatting

Troubleshooting

License