Skip to content
This repository was archived by the owner on Sep 1, 2021. It is now read-only.

Commit cd68709

Browse files
authored
Update README.md
1 parent 11bc241 commit cd68709

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,46 @@
1-
# Optimistic (moodleclient)
1+
<p align="center"><img src="icon.png" width="150px" height="150px" /></p>
22

3-
An Optima School better client.
3+
# ✍️ Optimistic (moodleclient)
44

5-
## Install the dependencies
5+
Vue.js Moodle Client based on moodle mobile api [(webservices)](https://docs.moodle.org/dev/Web_service_API_functions).
6+
7+
![GitHub issues](https://img.shields.io/github/issues/0x77dev/optimistic) ![GitHub pull requests](https://img.shields.io/github/issues-pr/0x77dev/optimistic) ![GitHub](https://img.shields.io/github/license/0x77dev/optimistic) ![GitHub contributors](https://img.shields.io/github/contributors/0x77dev/optimistic) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/0x77dev/optimistic) ![GitHub package.json version](https://img.shields.io/github/package-json/v/0x77dev/optimistic)
8+
9+
![Website](https://img.shields.io/website?down_color=lightgrey&down_message=offline&up_color=blue&up_message=up&url=https%3A%2F%2Foptimistic.0x77.page) ![Chromium HSTS preload](https://img.shields.io/hsts/preload/optimistic.0x77.page)
10+
11+
## Purpose
12+
This project was reverse engineering experiment, but now I'm going to create fully-featured Moodle Multi-Platform client.
13+
14+
## Roadmap
15+
16+
- [x] PoC: Auth implementation 🔐, webservices basic requests ⛓.
17+
- [x] [50%] Fully-Working Courses and Lesson View📚, with acceptable design👨‍💻.
18+
- [ ] Lesson Questions Support ❓
19+
- [ ] Auto Lesson (automatically brute force correct answers) _[If moodle server will support]_ 🤖
20+
21+
## CHANGELOG
22+
See in [CHANGELOG.md](CHANGELOG.md) 📓
23+
24+
## Getting Started Locally 🖥
25+
### Install the dependencies
626
```bash
727
yarn
828
```
929

10-
### Start the app in development mode (hot-code reloading, error reporting, etc.)
30+
#### Start the app in development mode (hot-code reloading, error reporting, etc.)
1131
```bash
1232
quasar dev
1333
```
1434

15-
### Lint the files
35+
#### Lint the files
1636
```bash
1737
yarn run lint
1838
```
1939

20-
### Build the app for production
40+
#### Build the app for production
2141
```bash
2242
quasar build
2343
```
2444

25-
### Customize the configuration
45+
### Customizing the quasar configuration
2646
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).

0 commit comments

Comments
 (0)