SharedMoments

(โ˜… 104)

A website designed for couples to capture and preserve their special moments

  • .dockerignore
  • .env.example
  • .gitignore
  • alembic.ini
  • config.py
  • docker-compose.yml
  • Dockerfile
  • install.sh
  • LICENSE
  • manage.py
  • README.md
  • requirements.txt
  • rollback_to_v1.py
  • run.py
  • uninstall.sh
  • update.sh

# Installation Guide

1. Get the code
git clone https://github.com/tech-kev/SharedMoments

Downloads the entire project code from GitHub to your computer.

cd SharedMoments

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://raw.githubusercontent.com/tech-kev/SharedMoments/main/install.sh | sudo bash

Type this command into your terminal and run it.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python manage.py runserver

Starts the Django development server.

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation