Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcusolsson/edith
An open learning platform based on Gatsby
https://github.com/marcusolsson/edith
Last synced: 1 day ago
JSON representation
An open learning platform based on Gatsby
- Host: GitHub
- URL: https://github.com/marcusolsson/edith
- Owner: marcusolsson
- License: mit
- Created: 2020-04-01T06:52:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T19:51:24.000Z (almost 2 years ago)
- Last Synced: 2024-11-10T09:47:07.491Z (6 days ago)
- Language: JavaScript
- Homepage: https://marcusolsson.github.io/edith
- Size: 9.96 MB
- Stars: 27
- Watchers: 4
- Forks: 5
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Edith
[](https://github.com/marcusolsson/edith/actions)
[](LICENSE)
[](#contribute)
Edith is a free and open source learning platform based on [Gatsby](https://www.gatsbyjs.org/) and [Material UI](https://material-ui.com/).
[Demo](https://marcusolsson.github.io/edith)
**Important**: Edith is still in early development and is not production-ready. **Use at your own risk**.
## Start using Edith
Edith is a [Gatsby theme](https://www.gatsbyjs.org/docs/themes/) and can be used like any other Gatsby plugin.
1. **Create a new site with the default starter**:
```
gatsby new my-site https://github.com/marcusolsson/gatsby-starter-edith-default
```
1. **Start developing**.
```
cd my-site
gatsby develop
```
1. **Navigate to [localhost:8000](http://localhost:8000)**.
Here are the available starters:
- [gatsby-starter-edith-default](https://github.com/marcusolsson/gatsby-starter-edith-default)
- [gatsby-starter-edith-dinosaurs](https://github.com/marcusolsson/gatsby-starter-edith-dinosaurs)
## Start developing
1. **Get the code**.
```
git clone https://github.com/marcusolsson/edith.git
```
1. **Start the site in develop mode**.
```
cd my-site
yarn workspace www develop
```
1. **Navigate to [localhost:8000](http://localhost:8000)**.
## Contribute
Edith welcomes contributions! This section lists some examples of how you can help. If you want to help in other ways than the ones listed below, [let me know](https://github.com/marcusolsson/edith/issues/new)!
- **Bugs**: Nobody likes bugs. If you find one, please [report it](https://github.com/marcusolsson/edith/issues/new). Tell me what happened, and what you expected to happen. Try to be as specific as you can.
- **Feature requests**: If you think something's missing, submit a [feature request](https://github.com/marcusolsson/edith/issues/new) and tell me what you'd like to see.
### User experience (UX)
Edith should be accessible to learners from different walks of life, cultures, and experiences. If you have experience in UX, web accessibility, or if just you feel something is hard to use, [let me know](https://github.com/marcusolsson/edith/issues/new).
### Documentation
Due to Edith still being in heavy development at this time, it's likely that any documentation will become outdated.
However, Edith needs sample content for demo purposes, to help people understand how _their_ experience would look like. If you'd like to write sample tutorials, or donate existing ones, let me know by [submitting an issue](https://github.com/marcusolsson/edith/issues/new).
### Code
If you know your way around code, I'd love your help working on feature and bug fixes.
Edith is based on [Gatsby](https://gatsbyjs.org), [React](https://reactjs.org/), and [Material UI](https://material-ui.com/).
Don't have experience in those technologies? Neither did I when I started this project. **We'll learn together**. If you have experience in Javascript, that's helpful.
## Mentorship
If you're excited about the idea of a open learning platform, but you don't yet feel you have the skills to contribute, I'd like to help you get there.
If you have any questions, either [submit a GitHub issue](https://github.com/marcusolsson/edith/issues/new), or reach out to me through the channels listed on the bottom of [my web site](https://marcus.se.net).
## License
Edith is licensed under the [MIT License](LICENSE).