generate links to share your snippet
Right now the application just provides code highlighting for some of the programming languages and generates url that could be shared.
What we want to build is a platform which will help coders to review others code, and give valuable feedback.
To attain this we need to follow some patterns to build this application.
-
Create an authentication model and store users and to able to create access rights and manage who can change modify the code. Also to store the generated code so that users can get all thier generated urls in one place.
-
Show differenes of other users that have changed the code
- like what new additions or deletions they have made to the code.
-
Able to add realtime code changes among users so that people can change and manage to code in realtime with others.
- To run and output the code shared by others
- Also to support multiple files at a time
- pull codebase from github or other online repositories
As this application is built on MERN stack and hosted in heroku platform. React is used for the front end paired with Express backend for api.
For data storage Airtable is used, as the application is still in developement stage. Once we get users we will move to mongodb
Follow the steps to for to setup for local server
- clone the repository
- run
npm installto install dependencies - now to install the dependencies for the client run
cd clientand then runnpm install. By now all the dependencies are downloaded now you can start the dev server - Go to the root directory if your in the client directory, run
cd ..to go to the root directory. - run
npm run dev-serverto spin up the express server - run
npm run dev-clientto spin up the react dev server
To contribute please follow the guidelines
- Fork this repo to create any pull request
- Clone your forked repo
- Make changes
- Create pull request
Before making any changes raise a issue and have a discussion with the maintainers first