https://github.com/lakesare/memcode

Spaced-repetition: with real formatting.
https://github.com/lakesare/memcode

memcode memory-game spaced-repetition-algorithm website

Last synced: 2 days ago
JSON representation

Spaced-repetition: with real formatting.

• Host: GitHub
• URL: https://github.com/lakesare/memcode
• Owner: lakesare
• License: mit
• Created: 2016-07-18T23:00:31.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-12-03T19:01:22.000Z (28 days ago)
• Last Synced: 2024-12-22T14:04:34.664Z (9 days ago)
• Topics: memcode, memory-game, spaced-repetition-algorithm, website
• Language: JavaScript
• Homepage: http://memcode.com
• Size: 56.1 MB
• Stars: 353
• Watchers: 10
• Forks: 75
• Open Issues: 58
• Metadata Files:
  • Readme: Readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

  

  





  Memcode





  Flashcards for coders and scientists. Open-source, free for all.





  



## Links

**Website**: memcode.com  

**Patreon**: patreon.com/memcode   

**Email**:   [email protected]    

**Twitter**: twitter.com/memcodeapp  

**Alternative.to**: alternativeto.net/software/memcode/about    

## Contributing

First of all - you are very welcome to contribute, Memcode is a joint effort.   

Before contributing, it's a good idea to create a related issue.

#### 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 the user a permission to create dbs, own all extensions, etc.: `ALTER ROLE postgres with superuser;`.

#### Copypaste environment variables.

1. Copy the example environment file with `cp env.example.js env.js`

2. Insert the necessary values - all those marked with "Required for local development"

#### Install the needed libraries.

1. Install npm.

2. Run `npm install`

#### Set up the database.

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

This will create the raw database for you - schema and a few necessary database rows.  

#### Start code compilers and server.

1. Run `make all` in your terminal.

This will start:

- `make backend-webpack` (compiles the backend code on every change)

- `make frontend-webpack` (compiles the frontend code on every change)

- `make start` (starts the node server)

for you.  

You can also run these separately if you wish to see the individual output.

2. Go to http://localhost:3000, and enjoy the development!