Cheat-sheet maker

A fullstack application to create and share tabulated cheat sheets using markdown syntax. The backend is developed with node-JS, express-JS and mongo-db while the frontend is developed with React.

Checkout the website.

Features

• Browse sheets made by others
• Sheet making and editing
• Syntax highlighting with various languages
• Authentication
• Fully Responsive on mobile screens (although creating sheets is not very practical on small screens).

Local testing

The project is divided into two parts, the server handles the backend and mongoDB access; and the client where the react frontend is implemented. To run the application locally, clone this repository and run npm install both in the main directory and in the client directory. Once the package installation is done, run npm run dev which will use concurrently and run/watch for modifications in the client and the server simultaneously.

Environment variables

• After creating a mongoDB cluster, assign the connection string to the variable dbURI in .env (create the file if not already present) of the main directory.

• You will also need to assign a value for the variable jwtSecret in .env which is needed by jsonwebtoken used for generating web tokens.

Todo

• Add rich text editor as an alternative to markdown
• More theming options
• Add search feature

keywords

React-JS, node-JS, express, redux, react-router, mongoDB, axios, markdown.

docker

create .env file to the root, this will then be shared as a volume to the backend and frontend. populate .env file with dbURI and jwtSecret docker-compose up to build and run

disclaimer

This repository is forked from mdtarhini/cheat-sheet-maker.