Giter Club home page Giter Club logo

galadrim-rooms's Introduction

Galadrim Tools

  • real time room booking tool
  • real time restaurant rating tool

galadrim tools home

see some other sample images here

Setup

  • for the backend you will need a mysql database (docker setup)
  • yarn install

Environment

on the frontend you need to create a .env you can copy and use the default .env.example

VITE_API_URL=http://localhost:3000/api
VITE_SOCKET_API_URL=http://localhost:3333

on the backend you need to create a .env you can copy and modify .env.example

the part you will need to adapt is the database connection settings

MYSQL_HOST
MYSQL_PORT
MYSQL_USER
MYSQL_PASSWORD
MYSQL_DB_NAME

Database

Docker mysql database

if you have docker/docker-compose installed, you can run it will launch a mysql server on the port 3310 you can edit this in docker-compose.yml

  • docker-compose up

database setup

  • cd ./apps/backend
  • node ace migration:run
  • node ace db:seed

Start project

  • at the root of the project run: nx dev backend and nx dev frontend

  • go to http://localhost:3000

  • login with the login / password of any of the users defined in this seeder file

Adonis CLI tool

on the backend you have access to a node script file ace: cd ./apps/backend node ace --help

you can read documentation about it here

some commands that you could need

# display all API routes with controller method used
node ace list:routes

# start a read-eval-print-loop with your project loaded
node ace repl

adonis repl documentation

Test project

When you write complex logic, try to write tests

to test project you can run those nx commands (nx commands needs to be run at the root of the project)

nx test backend nx test frontend nx test shared

Build project

(nx will build dependants projects if needed)

nx build backend nx build frontend

Contributing

  • fork the repo
  • create a branch: git checkout -b feat/awesomeNewFeature
  • commit and push your changes
  • make sure project can be built without errors, and tests still pass
  • create pull request

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.