Giter Club home page Giter Club logo

acidpattern's Introduction

AcidPattern

A screenshot of the development version of the acidpattern website, showing a grey navigation header, and a silver, box shaped synthesizer in the center, with a green LCD inside showing details about the synthesizer.

A site dedicated to sharing and composing patterns for the Roland TB-303 and its various clones and emulations. Still under development, but soon be live at acidpattern.com

Graphically inspired by early rave music forums, chunky VST design and old LCD panels.

Set Up

If you're working a fork of this project or looking to contribute, the following guide will help you get acidpattern running locally.

Installing Python Dependencies

This guide assumes you have python 3.12 or greater installed on your system. Compatibility with older version of Python has not been determined at this time.

In the root directory run python -m venv .venv to establish a virtual environment. Activate the environment with source .venv/Scripts/activate on Windows or source .venv/bin/activate on MacOS/Linux.

Install the dependencies with python -m pip install, if using poetry: poetry install.

Installing Node Dependencies

Navigate into the /frontend folder and run npm install to install the frontend dependencies.

Establishing the .env

Create a .env file in the root project directory and add the following code.

DJANGO_SERVER = 'http://localhost:8000'
FRONTEND_SERVER = 'http://localhost:5173'
DJANGO_SECRET_KEY = ''

In the /frontend folder, create .env containing the following:

VITE_BACKEND='http://localhost:8000'

If you're planning to run on different ports or a server, adjust accordingly.

You will also need to create a secret key for django. Activate a python shell in the terminal python and run the following.

from django.core.management.utils import get_random_secret_key
print(get_random_secret_key())

Take the secret key and use it as the DJANGO_SECRET_KEY

exit() to close the Python shell.

Creating the database

In the acidpattern_api/ directory, run python manage.py migrate to create the database.

Run python manage.py createsuperuser to establish a superuser for the database.

Running the development server.

Both servers simultaenously:

npm run dev in the frontend/ directory.

Only the django server:

python manage.py runserver in the acidpattern_api/ directory/

npm run django-dev in the frontend/ directory.

To run only the vite server:

npm run vite-dev in the frontend/ directory.

Testing

Tests can be run for the backend by navigating to acidpattern_api and running coverage run manage.py test within the venv shell.

License

Copyright 2024 Henry Oberholtzer

Original code licensed under a GNU GPLv3

acidpattern's People

Contributors

henry-oberholtzer avatar

Watchers

 avatar

acidpattern's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.