Edith

Edith is a free and open source learning platform based on Gatsby and Material UI.

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 and can be used like any other Gatsby plugin.

Create a new site with the default starter:

gatsby new my-site https://github.com/marcusolsson/gatsby-starter-edith-default

Start developing.
```
cd my-site
gatsby develop
```
Navigate to localhost:8000.

Here are the available starters:

Start developing

Get the code.

git clone https://github.com/marcusolsson/edith.git

Start the site in develop mode.
```
cd my-site
yarn workspace www develop
```
Navigate to 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!

Bugs: Nobody likes bugs. If you find one, please report it. 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 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.

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.

Code

If you know your way around code, I'd love your help working on feature and bug fixes.

Edith is based on Gatsby, React, and Material UI.

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, or reach out to me through the channels listed on the bottom of my web site.

License

Edith is licensed under the MIT License.

marcusolsson / edith