Giter Club home page Giter Club logo

edelgames's Introduction

Development Setup

Requirements

  • Docker Desktop 4.10.* or higher or a local nodejs and npm installation

With locale nodejs installation

  • Go into app/backend and run npm install then npm run dev
  • Go into app/frontend and run npm install then npm run start

This will start both apps in the development mode (using hot reload and less ts compiler optimization, as well as more logging). The Frontend will be available at http://localhost:3000/ and the backend at http:/localhost:5000/

With docker

  • Go into the root directory and run docker composer up -d

The development processes will be started automatically for you as long as the containers are running.

Hot reload

Both parts (frontend, backend) can use a hotloading feature (automatically started, when using docker) that allows development without constant restarts. ReactJS supports Hotloading out of the box. The Backend uses nodemon to detect and apply changes.

Development workflow

  1. Fork the repository
  2. Open a feature branch in your child repository (to maintain consistency, use git flow or similar)
  3. Make and commit your changes -> please do your fellow coders a favour and use semantic commit messages
  4. Repeat step 3
  5. Finish your feature branch
  6. Open a pull request for your changes in the main repository
  7. Remember to drink water, stay hydrated!
  8. Go to step 2

Deployment

  1. After your feature has been merged into the main repository, create a new version tag and merge the new state into the main branch
  2. tbd

Project standards

Frontend

  • Whenever possible, use class components
  • Place scss files next to its component and give it the same filename (excluding the extension)

edelgames's People

Contributors

brofian avatar kid2407 avatar teekeks avatar

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.