violet_rails

(โ˜… 109)

an app engine for your business. Seamlessly implement business logic with a powerful API. Out of the box CMS, blog, forum and email functionality. Developer friendly & easily extendable for your next SaaS/XaaS project. Built with Rails 6, Devise, Sidekiq & PostgreSQL

  • .browserslistrc
  • .buildpacks
  • .env.development
  • .env.test
  • .gitattributes
  • .gitignore
  • .ruby-version
  • app.json
  • babel.config.js
  • Capfile
  • ci_env.cfg
  • clean_run_tests.sh
  • CODE_OF_CONDUCT.md
  • config.ru
  • CONTRIBUTING.md
  • docker-compose.yml
  • docker-entrypoint.sh
  • Dockerfile.dev
  • Gemfile
  • Gemfile.lock
  • local.conf
  • MIT-LICENSE
  • nginx.conf
  • nginx.Dockerfile
  • package.json
  • postcss.config.js
  • Procfile
  • Rakefile
  • README.md
  • run_tests.sh
  • SECURITY.md
  • test-entrypoint.sh
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/restarone/violet_rails

Downloads the entire project code from GitHub to your computer.

cd violet_rails

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
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 --build

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.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd client

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

โœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation