musical-tracker-api

Welcome to the Musical Tracker API! This is a robust js-based API built using TypeScript, Node.js, and Express, with Drizzle ORM for database management. It's designed to help you effectively manage and track musical data, offering a seamless integration for developers and music enthusiasts alike.

• Schema Graph v3

Prerequisites

• Node.js v22
• Docker

Setup Instructions

1. Clone the Repository

git clone git@github.com:ChrisForti/musical-tracker-api.git
cd musical-tracker-api

2. Install Dependencies:

npm install

3. Setup Environment Variables:

cp .env.example .env

The API server runs on port 8000 by default. You can override this by setting the PORT environment variable in your .env file:

PORT=8000  # Default port for the API server

Edit the .env file and configure:

• DATABASE_URL - Your PostgreSQL connection string
• AWS_ACCESS_KEY_ID - Your AWS access key (required for image uploads)
• AWS_SECRET_ACCESS_KEY - Your AWS secret key (required for image uploads)
• AWS_S3_BUCKET - Your S3 bucket name (required for image uploads)
• AWS_REGION - Your AWS region (e.g., us-east-1)

Note: Image upload features require AWS S3 configuration. Use the debug endpoint GET /v2/upload/debug to verify your AWS setup.

4. Start the database:

docker compose up
# If you want to run in the background, start detached:
# docker compose up -d

5. Run Database Migrations:

npm run db:migrate

6. Start the dev server

npm run dev

The server will start on http://localhost:3000.

Troubleshooting

Database Issues:

• Ensure the database connection string in .env is correct
• Make sure Docker containers are running: docker compose ps
• Check logs for errors during API requests

Image Upload Issues:

• Verify AWS credentials are configured in .env
• Test AWS configuration: curl http://localhost:3000/v2/upload/debug
• Common error: "AWS_S3_BUCKET not configured" means missing S3 bucket name
• Ensure your AWS credentials have S3 permissions

Getting Started:

• See API documentation in DOCS/v2-api-endpoints.md
• All upload endpoints require authentication
• Images return signed URLs valid for 24 hours

License

⚠️ NON-COMMERCIAL USE ONLY

This project is licensed under a custom license that prohibits commercial use without explicit permission.

• ✅ Allowed: Personal use, education, research, open source contributions
• ❌ Prohibited: Commercial use, selling, monetization, proprietary applications

For commercial licensing inquiries, please contact the repository owner.

See the LICENSE file for full details.