Skip to content

deinsoftware/cronos

Repository files navigation

Cronos

build deploy Sonar-reliability sonar-security sonar-maintainability sonar-coverage license Prettier ESLint React Open in VSCode

Cronos

Cronos was created to help people to practice English for free and learn by doing!

Menu


Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install?

  • node.js - LTS Version: 14.17.0 (with npm 6.14.13)

Development

Clone or download project and install dependencies.

git clone https://github.com/deinsoftware/cronos.git
cd cronos
npm i

Run

If you want to run this project locally in development mode use the command

npm start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Back to menu


Folder Structure

├─ public
└─ src
    ├─ assets
    ├─ components
    │   ├─ layouts
    │   ├─ sections
    │   ├─ shared
    │   └─ ui
    ├─ data
    ├─ utils
    ├─ pages
    └─ index.js
Folder Content
assets Images and file resources
layouts Layout components for main pages (eg. LandingLayout, AuthLayout)
sections Sections components (eg. Header, Footer)
shared Shared components that have business logic (eg. Answer, Listen)
ui Smaller components that have no business logic or side effects (eg. Logo, Button)
data Share CONSTANT (eg. combobox list).
utils Function helpers (eg. helpers).
pages All the pages

A rule of thumb is to create a helper function when you need specific functionalities in more than one place.

Back to menu


About

Built With

Libraries

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the Cronos on GitHub.

Authors

See also the list of contributors who participated in this project.

Sponsors

If this project helps you, consider buying me a cup of coffee.

GitHub Sponsors paypal

License

This project is licensed under the MIT License - see the LICENSE file for details.

Back to menu