Git Product home page Git Product logo

rex's Introduction

rex

rex is a Really EXcellent way to develop webapps.

Quickstart

First, (install Docker)[https://docs.docker.com/install/].

Next, run

npm run docker:db:sync:force
npm start

To get a development environment. The first time you run these commands we'll build a bunch of docker images and do a bunch of initialization - please be patient.

Visit (http://localhost:8080)[http://localhost:8080] to see your running app.

I'd like to...

work on the whole app

npm run db:sync-force # you only need this the first time you run the app
npm start

This will spin the whole system up in docker containers. Code changes in either the api or ui projects will be automatically reloaded (though there is usually at least a short delay).

work on the frontend

npm run storybook

This will spin up storybook on your machine (without Docker). Watch the console for instructions on accessing the Story Book. Code changes in the ui project will be automatically reloaded.

work on the API

npm run docker:api:watch:test

This will run the api project tests and then automatically re-run them when code in the api project changes. API development should be primarily test-driven.

run all the tests once

npm test

reset the database

npm db:sync-force

do something that isn't documented here

Add a new section with the thing you'd like to be able to do and TODO: in the body. Submit a PR. Ask someone who might know how to do the thing to review and update the PR!

Common issues

Docker incorrect credentials error

This error sometimes occurs when first running the stack. To fix this, try signing out of your Docker desktop account.

rex's People

Contributors

travis avatar epeery avatar

Stargazers

Roman avatar

Watchers

 avatar James Cloos avatar  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.