README
¶
floorpLanETS || floor(p)LanETS || floorplanETS
New floorplan for lanets.ca
Installing dev environment
Make sure you have docker, docker-compose and Make installed on your machine.
Building
To build the Floorplan API and client, run:
$ make
Starting the Floorplan API
To start the Floorplan API, run:
$ make run-floorplanets
The API should start listening for requests at localhost:8080.
Starting the Floorplan client
To start the Floorplan client in dev mode, run:
$ make reactapp
The application should be running at localhost:3000. Dev mode runs the application with a watcher, reloading the app on source code change.
Running the tests
To run the tests, run:
$ make test
Directories
¶
| Path | Synopsis |
|---|---|
|
backend
|
|
|
api
Package api provides a router that calls app actions
|
Package api provides a router that calls app actions |
|
app
Package app is reponsible for executing the application's actions.
|
Package app is reponsible for executing the application's actions. |
|
cmd/floorplanets/internal/cli
Package cli is responsible for parsing command line arguments and creating a server instance.
|
Package cli is responsible for parsing command line arguments and creating a server instance. |
|
models
Package models contains the models for floorplanets
|
Package models contains the models for floorplanets |
|
server
Package server contains the core of the flooplanets server
|
Package server contains the core of the flooplanets server |
|
server/internal/http
Package http is responsible for creating an HTTP server
|
Package http is responsible for creating an HTTP server |
|
tests/api
Package api provides testing facilities for the api package
|
Package api provides testing facilities for the api package |
|
tests/app
Package app provides testing facilities for the app package
|
Package app provides testing facilities for the app package |
Click to show internal directories.
Click to hide internal directories.