Awesome Open Source
Awesome Open Source
Sponsorship

CaptainFact.io

Discord AGPL3 Build Status



Getting started

If you're already have the API running locally, a simple npm install && npm start should be enough. Otherwise follow the procedure below:

  • Install (if you don't have them):

    • Docker and docker-compose (to start the API easily)
    • NodeJS, ideally using asdf-vm with NODEJS_CHECK_SIGNATURES=no asdf install
    • App dependencies: npm install
  • Run:

    • docker-compose up - Start the API
    • npm start - Start the front-end
    • npm run test - Runs all unit tests

Front-end is started on http://localhost:3333

A default account should have been created for you with e-mail=[email protected] and password=password.

Conventions

File structure

app
ā”œā”€ā”€ API => API libraries for both REST API and websockets
ā”œā”€ā”€ assets => Assets imported from JS
ā”œā”€ā”€ components => All react components
ā”œā”€ā”€ i18n => Translations
ā”œā”€ā”€ lib => Misc utilities
ā”œā”€ā”€ state => All redux related
ā”‚Ā Ā  ā”œā”€ā”€ comments
ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ effects.js => Async actions creators, always return a promise
ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ record.js => The object representing a single comment
ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ reducer.js => Reducer + actions creators, always return an action object
ā”‚Ā Ā  ā”‚Ā Ā  ā””ā”€ā”€ selectors.js => Re-select selectors to select data in state
ā”‚Ā Ā  ā””ā”€ā”€ ...
ā”œā”€ā”€ static => Static assets, directly copied to the public directory
ā”œā”€ā”€ styles => Stylesheets in .sass format, all included from application.sass
ā””ā”€ā”€ router.jsx => Application router and main entry point

Styling

Styling is based on Bulma and was initially customized with SASS. However we now include styled-components, styled-system and @rebass/grid. This has become the prefered way to build new components.

Icons

We bundle a custom font icon built with IcoMoon. You can find scripts and config for this in dev/ but the preferred (and easiest) way to add new icons today is to use https://styled-icons.js.org/.

Main Libraries / Frameworks

Linked projects

License

GNU AFFERO GENERAL PUBLIC LICENSE Version 3

Permissions of this strongest copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available.

See LICENSE for more info.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (66,552)Ā 
react (4,919)Ā 
hacktoberfest (4,322)Ā 
frontend (462)Ā 
spa (176)Ā 
civic-tech (27)Ā 
collaborative (18)Ā 

Find Open Source By Browsing 7,000 Topics Across 59 Categories