Skip to content

lakesare/memcode

 
 

Repository files navigation

Website memcode.com GitHub contributors Gitpod Ready-to-Code GitHub license PRs Welcome

Memcode

Flashcards: for coders, mathematicians, and physicists. Open-source, free for all.
Made with love 💘

Links

Site ❤️: www.memcode.com
Email: [email protected]
Twitter: https://twitter.com/memcodeapp

Alternative.to: https://alternativeto.net/software/memcode
Slack: please write to [email protected] to request access

Contributing

Initial setup for development

Note: if you'd like to use online development environment, see https://github.com/lakesare/memcode/blob/master/Gitpod.md. Steps below are for local setup.

Create a database postgres user with a password.

  1. Install PostgreSQL.
  2. Go to postgres console: psql postgres.
  3. Create a postgres user with password: CREATE ROLE postgres WITH LOGIN PASSWORD postgres;.
  4. Give them a permission to create dbs, own all extensions etc.: ALTER ROLE postgres with superuser;.

Copypaste environment variables.

  1. Ask someone for env.js file, put it in the root folder (next to package.json). Inside of env.js, change DB_USER and DB_PASSWORD to relevant values (your postgres's user and password).

Install needed libraries.

  1. Install npm.

How to run the site locally?

Set up the database.

  1. Create a new development database 'memcode': make db-reset.

Start code compilers and server.

  1. Run npm install.
  2. Run make backend-webpack, make frontend-webpack, make start. If you are on windows - you can use equivalent npm commands.

Optionally: populate database (please request access to heroku from the owner if you truly need access to production database for some reason).

  1. Install heroku cli.
  2. heroku login.
  3. Make sure heroku knows about our app: heroku git:remote -a memcode.
  4. Pull courses from the database with make heroku-db-pull.

About

Flashcards. Beautiful. Effortless.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors