Skip to content

Contributing.md

Latest commit

 

History

History
52 lines (34 loc) · 2.12 KB

Contributing.md

File metadata and controls

52 lines (34 loc) · 2.12 KB

Contributing

First of all - you are welcome to contribute, Memcode is a joint effort.
Feel free to ask questions/propose features in github issues, or email contact@memcode.com.

Github Codespaces

If you would like to develop in the browser, you can simply open Github Codespaces - after a few minutes of waiting, in the PORTS tab, a few ports will appear. Click on the port 3000. This will open a browser window, where you can see normal memcode.com ui. You can now edit both frontend and backend code in Github Codespaces - the changes will get reflected in the ui automatically.

When developing in Github Codespaces, please username&password to register.

Local setup

One-Time Setup

Create a database

  1. Install PostgreSQL (any modern should work, for example v14.17 and v16.9 certainly work)
  2. Go to postgres console: psql postgres (as the default postgres superuser)
  3. Create a memcode user with password: CREATE ROLE memcode WITH LOGIN PASSWORD 'memcode';.
  4. Give the user permission to create databases: ALTER ROLE memcode CREATEDB;.
  5. Create a new development database 'memcode': make db-reset. This will create the raw database for you - a schema and a few necessary database rows.

Note

The project uses a PostgreSQL user named memcode with password memcode for the database memcode. All database commands in the Makefile are configured to use these credentials.

Copypaste environment variables

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

    For basic development you do not need to change anything in this file.

Install the needed libraries

  1. Install node v22.19.0
  2. Install npm
  3. Run npm install

Development

  1. Run make frontend-webpack (compiles the frontend code)
  2. Run make start (starts the node server)
  3. Go to http://localhost:3000, and enjoy the development!
    Locally, please use username&password to sign up.

Memcode Logo