Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmarchois/topflop
Top, flop or quote your friends
https://github.com/mmarchois/topflop
hexagonal-architecture mercure nodejs reactjs realtime redux typescript
Last synced: 12 days ago
JSON representation
Top, flop or quote your friends
- Host: GitHub
- URL: https://github.com/mmarchois/topflop
- Owner: mmarchois
- Created: 2019-10-01T12:18:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T03:41:10.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T12:54:21.397Z (28 days ago)
- Topics: hexagonal-architecture, mercure, nodejs, reactjs, realtime, redux, typescript
- Language: CSS
- Homepage:
- Size: 6.28 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :rocket: TopFlop :rocket:
Topflop is a realtime open-source application to top, flop or quote your friends.
## Getting Started
### Server side
#### Setup docker
```bash
$ cd server/
$ make init-database
$ make start
```
- API is available on http://localhost:3000/
- API doc is available on http://localhost:3000/_doc
- Mercure hub available on http://localhost:1337
### App side
```bash
$ cd client/
$ make start
```
- App available on http://localhost:3001
## Technical stack
TopFlop depends on the following technologies:
### Backend stack
- [Node.js](https://nodejs.org)
- [Nestjs](https://nestjs.com/)
- [Typescript](https://www.typescriptlang.org/)
- [Docker](https://www.docker.com/)
- [PostgreSQL](https://www.postgresql.org/)
- [Mercure](https://mercure.rocks)
### App stack
- [React.js](https://fr.reactjs.org/)
- [Redux](https://redux.js.org/)
- [Axios](https://github.com/axios/axios)
# License
TopFlop is an open-sourced application licensed under the [MIT license](https://opensource.org/licenses/MIT).