Skip to content

This repository contains the development data of the server for a cloud infrastructure service for Optolith Character Generator (https://github.com/elyukai/optolith-client).

License

Notifications You must be signed in to change notification settings

Onyxmoon/optolith-cloud

Repository files navigation

Welcome to Optolith Character Generator - Cloud 👋

Version License: Mozilla Public License 2.0 Twitter: onyxmoon_

This repository contains the development data of the server for a cloud sync infrastructure service for Optolith Character Manager (https://github.com/elyukai/optolith-client).

Install

This application needs

  • PHP > 7.3
  • composer latest

Recommendend add-ons

  • symfony development kit

To prepare the application and install all dependencies use in a terminal:

composer install

Usage

📝 Configuration

Please add the following information to a an .env.local file

# App Mode
# 'prod' in production, will disable test tools and increase performance
APP_ENV=dev

# This secret string is 40 random characters that is used for CSRF protection.
# Generate one at: http://nux.net/secret
APP_SECRET=652f40901a1e2230e2b1ab86cc810835b13bc4a5

# Database configuration
# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
# For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
# For a PostgreSQL database, use: "postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=11&charset=utf8"
# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
# DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7
DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db

# Mail configuration
# While testing you can disable the need for an mail dsn with 'null://null'
MAILER_DSN=smtp://<mail-adress>:<password>@<smtp-server>>

🔪 Prepare database

Prepare sql terms for database depending on current condition

php bin/console make:migration

Apply changes to database

php bin/console doctrine:migrations:migrate

🧪 Development test run

php bin/console server:run

📨 Deploy

For deployment on specific webservers, take a look into the symfony documentation

Author

👤 Onyxmoon (Philipp Borucki)

👤 elyukai (Lukas Obermann)

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Onyxmoon (Philipp Borucki).
This project is Mozilla Public License 2.0 licensed.