Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 2.64 KB

README.md

File metadata and controls

106 lines (69 loc) · 2.64 KB
Raw

Smart Village App - Main-Server

Maintainability Test Coverage

Please visit the german website to get in touch with us and present your ideas and visions: https://smart-village.app.

 

This main-server is one main part of the whole Smart Village App project. For more information visit https://github.com/ikuseiGmbH/smart-village-app.

Setup process

Common setup master branch

1. Ruby installation

  • for Ruby version issues
export CFLAGS="-DUSE_FFI_CLOSURE_ALLOC"
export PKG_CONFIG_PATH="$(brew --prefix openssl@1.1)/lib/pkgconfig"
ruby-install 2.6.8 -- --with-openssl-dir=$(brew --prefix openssl@1.1)

2. Bundler installation

gem install bundler -v '2.3.20'

Master key configuration

Create config/master.key if needed with the correct key.

Database configuration

Create a config/database.yml file with e.g. the following content:

default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: root
  password:
  socket: /tmp/mysql.sock

development:
  <<: *default
  database: smart_village

test:
  <<: *default
  database: smart_village_test

Database and user setup

1. Ru the following commands

rake db:create db:migrate

Import a SQL dump or use

rake db:seed

3. Change the user password in Rails console:

user = User.first
user.password = user.password_confirmation = "my_new_password"
user.save

Run the server locally

rails s

Login

User management

At http://localhost:4000/accounts you can manage users and also assign permissions. Important!!! Without the correct permissions, you cannot log in and will receive the error message:

Error! E-Mail oder Passwort ist falsch.

GraphQL API

There is also the option to use the GraphQL API at http://localhost:4000/graphiql and send various requests. Examples can be found in the doc folder doc/poi_mutation_example.graphql and doc/poi_mutation_example.graphql.

Tech Stack

  • Ruby version: 2.6.8
  • Rails version: 5.2.4