Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/takeit/students-app

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/takeit/students-app
Owner: takeit
License: mit
Created: 2019-06-12T09:14:16.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-12-08T18:05:56.000Z (about 2 years ago)
Last Synced: 2024-10-27T23:14:11.162Z (3 months ago)
Language: TypeScript
Size: 3.62 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        


  

 



OwnCourses Students App




  [![Status](https://img.shields.io/badge/status-active-success.svg)]() 

  [![GitHub Issues](https://img.shields.io/github/issues/owncourses/students-app.svg)](https://github.com/owncourses/students-app/issues)

  [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/owncourses/students-app.svg)](https://github.com/owncourses/students-app/pulls)

  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

  [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/owncourses/students-app)



Application for OwnCourses students.

---

## Features

- [x] Login/logout

- [x] User courses list

- [x] modules/lessons in courses

- [x] Single lesson page

- [x] Additional course attachments

- [x] Course authors

- [x] Mark lesson as completed

- [ ] Course/module progress info

# Development installation notes

`yarn` - install dependencies

`yarn start` - run build in server

##### App requires working server instance with API. Install and run it locally or use our demo instance for preview: 

Set this in `.env` file:

`SERVER_URL="https://owncourses.org"`

Login data for https://owncourses.org API:

```

Login: [email protected]

Password: testPassword

```

# Production build notes

Adjust app settings (used on build time) with `.env` file. Default values are picked from `.env.defaults`

`yarn` - install dependencies

`yarn build` - run production build

**Works great deployed with Netlify**

Netlify build settings: 

* Build command: `yarn build`

* Publish directory: `build`