Project.md

Work in progress 👷‍♂️

📝 Exemplary markdown inspired project management built with; React, Node, GraphQL, MongoDB, Redis & Minio/S3.

Tired of complicated project management systems? What something that speaks to the Markdown 🐱‍👤 inside of you? Project.md is designed with simplicity at its heart, letting you manage projects & present your ideas with pure Markdown. No longer shall you recursively search nested 'sub tasks' to oblivion.

Tech Stack

1. Backend
   • Node.JS
   • Minio/S3
   • MongoDB
   • Redis
2. Frontend
   • React.JS

Contributing

All contribution's welcome 🍺 Make a PR or issue & let's take it from there.

Getting Started

Environment variables copy ./.env.example => ./.env You may need to adjust variables to suit your setup.

Emails

This project uses Nodemailer to send emails, you will need to adjust the config in either ./server/.env or if you are using Docker adjust the variables in ./docker-compose.yml.

EMAIL_HOST=smtp.ethereal.email
EMAIL_PORT=587
EMAIL_USER=testuser
EMAIL_PASSWORD=password
EMAIL_SECURE=true
EMAIL_FROM=no-reply@project-md.com

Server

1. MongoDB Server
2. Redis
3. Minio
4. cd server
5. npm install
6. npm run start

Renderer Service

1. MongoDB Server
2. Redis
3. Minio
4. cd services/renderer
5. npm install
6. npm run start

Client

1. cd client
2. npm install
3. npm run start

Docker

Use this to start client, server & dependencies all at once, take consideration for any conflicting services. Make sure you configure email config in docker.compose.yml 🐳

1. docker-compose up

Docker Containers

Use the following commands to setup the dependencies manually

MongoDB

$ docker run -d --publish 27017:27017 --name project-md-mongo mongo 

Redis

$ docker run -d --publish 6379:6379 --name project-md-redis redis

Minio/S3

$ docker run -d --publish 9000:9000 --name project-md-minio -e MINIO_ACCESS_KEY=accesskey -e MINIO_SECRET_KEY=secretkey minio/minio server /data

Screenshots

Demo coming soon, style is work in progress 🏗

Global Search

Documents

Create Document

Document Export

PDF

Markdown

Project

Profile