/captain-fact-frontend

🔎 CaptainFact - Frontend. The one you see on https://captainfact.io

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

CaptainFact.io

Discord AGPL3 Build Status Coverage Status Greenkeeper badge

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 with NODEJS_CHECK_SIGNATURES=no asdf install
    • App dependencies: npm install

  • Run:

    • docker-compose up - Start the API
    • npm start - Start the frontend
    • npm run test - run all unit tests

A default account should have been created for you with email=admin@captainfact.io and password=password. See CONTRIBUTING.md for more details.

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

Main Libraries / Frameworks

  • ES6 with Babel
  • ReactJS: vue layer
  • Redux: state management
  • ReactRouter: routing
  • phoenix: interaction with phoenix socket
  • Bulma: base styles

Linked projects

Feature requests

Feature Requests

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.