jays.pics

---

Table of Contents

• Introduction
• Development
• Contributing
• License

---

Introduction

jays.pics is a online image host that allows users to store their images with tags, and access and share them across multiple domains, donated by users.

---

Development

Prerequisites

This README assumes you have Docker installed. If you do not, please read this manual, based on your operating system. It will cover setting up and testing your very own Docker instance (lucky you!)

Requirements

• Node 20.0.0
• Docker: 27.3.1

Steps

Cloning and initial setup

1. Clone the repository with

   git clone https://github.com/jeepies/jays.pics.git

2. Enter the cloned repository locally, typically with

   cd jays.pics

3. Install all dependencies with

   npm i

Setting up the database

1. Ensure your Docker instance is started by running

   docker info

2. Compose the containers

   docker compose up -d

Creating the environment

1. Create a new .env file at the root of the project
2. Refer to the example.env file, replacing values where required

Migration and Seeding

1. Run all of the migrations by executing

   npx prisma migrate dev

2. Seed the database with

   npx prisma db seed

3. You can check the database is migrated and seeded by running

   npx prisma studio

Running the application

1. You can start the development server with

   npm run dev
   

Contributing

Contributions are welcome! 🥳

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes with a clear message.
4. Open a pull request describing your work.

License

MIT © jeepies

---

Made with by jeepies