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

Requesting a feature

Over the years since Memcode's inception, we've received a ton of feature requests. Your suggestions have helped shape Memcode into the beautiful tool for thought it is today. However, every feature has associated development costs in terms of time and resources. This often leads to a backlog of issues and potential for features to go stale.

To address this and ensure that your desired features are implemented, I'm introducing a new approach to feature development. This will allow you to have a direct hand in the betterment of Memcode.

The process:

• Feature Requests: If you have an idea for a feature, create an issue on the github issues page.
• Estimation: I'll look over your request, figure out how much work it will take, and put a price on it.
• Payment: If you're okay with the price, you can pay to have it implemented in the next few weeks.

Remember, don't hesitate to propose feature ideas even if you're not in a position to cover the cost. Knowing your needs and desires for Memcode is invaluable, and it's quite possible someone else might resonate with your idea and be able to fund its implementation.

Contributing

First of all - you are very welcome to contribute, Memcode is a joint effort.
Feel free to ask questions/propose features in github issues, or join our developer Slack (please write to [email protected] to request access).

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. Either copy the example environment file with cp env.example.js env.js, and insert the required values yourself,
2. Or write to [email protected] and I will send you a ready env.js file. In either case, you will need to insert your own DB_USER and DB_PASSWORD that you created in the previous step.

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, a few necessary database rows, and nothing else. If you would like a bigger database to have something to work with, please write to [email protected], and I will create a development dump for you.

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!