Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nearhuscarl/nearacademy

Comprehensive UI mockups of an online education website written in React
https://github.com/nearhuscarl/nearacademy

academy education educational mockup react reactjs ui ui-design

Last synced: about 1 month ago
JSON representation

Comprehensive UI mockups of an online education website written in React

Awesome Lists containing this project

README

        

# [Near Academy]

An [education website] to help students prepare for the gruesome national exams by
providing the latest sample tests and exercises with the support from a group of
volunteering and talented teachers. Our mantra is: education should be free* and
accessible for anyone, just like communism.

*except teacher supporting. They need something to eat.

## Features

### For Students

* Receiving support from a group of famous, talented and seasoned teachers.
* Modern online learning approach, students are the one who ultimately control where and when to learn unless they have helicopter parents.
* Cheaper price than the traditional method. Even cheaper than lifetime Pornhub Premium.
* Huge exercise storage and active forum which help students practice and discuss
in the most efficient way. Knowledge is shared online for everyone, a bit like communism.

### For Teachers

* Be known and beloved by student all over the country.
* Additional income, which can scale up quickly the more students you have and the more you have them clicking the ads, a bit like capitalism.

## Development

```bash
yarn dev-server
```

## Deployment

```bash
# Use npm instead of yarn because up until now (20/11/2019)
# yarn does not support passing arguments to npm script
npm run deploy --M='commit message'
```

### Commit message convention

My commit message convention is similar to the one from [Angular team](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type)
but with an additional type `imp` which means improve or polish existing feature(s)

* build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
* ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
* docs: Documentation only changes
* feat: A new feature
* imp: Improving or polishing existing feature(s)
* fix: A bug fix
* perf: A code change that improves performance
* refactor: A code change that neither fixes a bug nor adds a feature
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* test: Adding missing tests or correcting existing tests

[Near Academy]: https://nearhuscarl.github.io/nearacademy/
[education website]: https://nearhuscarl.github.io/nearacademy/