Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sproogen/itsgoingto.be
The magic behind itsgoingto.be
https://github.com/sproogen/itsgoingto.be
composer docker es6 es6-javascript javascript php poll react storybook symfony
Last synced: 9 days ago
JSON representation
The magic behind itsgoingto.be
- Host: GitHub
- URL: https://github.com/sproogen/itsgoingto.be
- Owner: sproogen
- License: gpl-3.0
- Created: 2015-09-18T08:48:51.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T05:15:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T19:33:08.831Z (24 days ago)
- Topics: composer, docker, es6, es6-javascript, javascript, php, poll, react, storybook, symfony
- Language: JavaScript
- Homepage: http://www.itsgoingto.be/
- Size: 6.16 MB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# itsgoingto.be  [](https://sonarcloud.io/dashboard?id=sproogen%3Aitsgoingto.be) [](https://sonarcloud.io/dashboard?id=sproogen%3Aitsgoingto.be)
NodeJS and React magic behind [itsgoingto.be]
The Node backend can be found in the `server` folder and the React app can be found in the `app` folder.
Getting started
-------------
You will need to have [Docker] installed and running, aswell as Node and NPM.
Clone the repository into a local folder.
Now inside the project folder run
```
./app/docker-build.sh
./server/docker-build.sh
docker-compose up
```
You will now be able to access the app at `http://localhost:8000`, storybook at `http://localhost:6006` and swagger at `http://localhost:4000`.
Everytime you make a change to the app or storybook stories the app will automatically rebuild and refresh in the browser.
*Note: If you make any changes to the packages in the app or server you will need to re-run the relevant `docker-build.sh` script.*
Running tests
-------------
###### App
To test the React app, run the folowwing from inside the `app` folder.
`npm run lint` to run the linter.
`npm run test` to run all the unit tests using jest.
###### Server
To test the Node Server, run the folowwing from inside the `server` folder.
`npm run lint` to run the linter.
`npm run test` to run all the unit tests using jest.
*Note: You will need to have [Docker] running to run the server tests, as this uses a docker container for a mysql server.*
API
-------------
API documentation can be found at [server/swagger.yml](server/swagger.yml)
Copyright
-------------
```
Copyright (c) 2018 James Grant
```
License
-------------
```
ItsGoingToBe is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
ItsGoingToBe is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with ItsGoingToBe. If not, see .
```
[itsgoingto.be]: http://itsgoingto.be/
[Docker]: https://docs.docker.com/get-started/