Giter Club home page Giter Club logo

cheat-sheet-maker's Introduction

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).

Screenshots

Home Page

Home page screenshot

Sheet maker

Sheet maker screenshot

sheet example

example sheet screenshot

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.

cheat-sheet-maker's People

Contributors

mdtarhini avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.