Light

ayasechan / memoet Goto Github PK

View Code? Open in Web Editor NEW

This project forked from memoetapp/memoet

0.0 0.0 0.0 1.72 MB

A self-hosted spaced repetition software

License: GNU Affero General Public License v3.0

Shell 0.83% JavaScript 1.41% Rust 12.21% Elixir 59.09% HTML 24.79% Dockerfile 0.29% SCSS 1.37% Procfile 0.02%

memoet's Introduction

Memoet

Play quizzes & review flashcards to memorize everything using spaced repetition method

User guide

See memoet.gitbook.io.

Developer guide

Install asdf

Follow instructions here.

Install Rust

Follow instructions here.

Install erlang, elixir and nodejs

asdf install

Install project dependencies

mix deps.get
(cd assets && npm i)

Migrate database & start server

mix ecto.setup
mix phx.server

Now you can visit localhost:4000 from your browser.

Deployment

Docker: docker-compose.yml.
Ubuntu: ubuntu.sh
Heroku: heroku.sh

Environment

Basic setup:

Environment	Required?	Why?
`SECRET_KEY_BASE`	Yes	For cookies encryption, can be generate with `openssl rand -hex 48`
`DATABASE_URL`	Yes	For saving stuffs, only Postgres is supported for now
`DATABASE_SSL`	No
`DATABASE_CERT`	No
`DATABASE_IPV6`	No	For database conn with IP v6

For your custom domain:

Environment	Example
`URL_HOST`	memoet.com
`URL_PORT`	443
`URL_SCHEMA`	https

For uploading images to S3:

Environment	Example
`AWS_BUCKET_NAME`	cdn.memoet.com
`AWS_ACCESS_KEY_ID`	xxxxxxxxxxxxxxxx
`AWS_SECRET_ACCESS_KEY`	xxxxxxxxxxxxxxxx
`AWS_REGION`	us-east-1
`AWS_ASSET_HOST`	https://cdn.memoet.com

Extra configuration:

Environment	Why?
`SENDINBLUE_API_KEY`	For password recovery email
`SENTRY_DSN`	For error logging

memoet's People

Contributors

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.