esfiddle / codesnippets

Offline-ready code snippets store

ESFiddle

Try out the latest ES6+ features right in your browser.

See it online here.

Getting Started

This guide assumes you already have MongoDB and NodeJS installed. Click here for instructions on how to install MongoDB and NodeJS

Clone the repository

# Get the latest version
git clone [email protected]:esfiddle/esfiddle.git

# Change directory
cd esfiddle

# Update the PRIVATE section in sample.env file. 
# Replace the text 'keyboard-cat' set for SESSION_SECRET to a value generated from the following site:

RANDOM.ORG

# rename the sample.env file to '.env'
cp sample.env ./.env

# Open a new terminal window and start MongoDB
mongod --dbpath path/to/your/db/folder

# Install the dependencies
npm i

# Start the application
npm start

Found a bug?

Read the Help I've Found a Bug article and follow its instructions.

Want to know what we are working on?

Check out our vision.

Contributing

We welcome pull requests from first-timers and seasoned veteran programmers alike. Follow the steps above to get setup.

In addition to this we are looking for maintainers. Please come and chat with us in our gitter if you are interested.

Please first review the Code of Conduct and the Contributing guide to help you get setup. Our Style Guide is based on the Airbnb style guide.

You can help to triage issues. This can include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to subscribe to esfiddle/esfiddle on CodeTriage.

Then have a look at some of the projects issues Checkout the labels first-timers-only, bite-size (for small issues) and up-for-grabs.

codesnippets's Issues

Add Code of Conduct document

Add a code of conduct document because everyone should feel welcome in open source! 🎉

Vision :: Please Read!

We need to decide what we want to do with this project.

My original idea was to have an offline-ready PWA that could be viewed on mobile or desktop (eventually we would distribute a downloadable program using electron).

The applications purpose is to easily store and categorise code snippets. It would allow you to embed them into your site.

It would operate like Evernote or Onenote, you have notebooks that then have notes tied to them - rather than just a flat document store. This enables me to have a notebook for things like 'Web' and another for 'React Native' or whatever.

I was thinking also that it would be useful to build extensions for various code editors (such as VSCode or Atom) that would enable you to access your snippets from there and include them.

What do you guys think? We need to narrow this down to an MVP, so what do you think should be included?

Add Google Login

Using PassportJS add a Google Login functionality

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

App Design

Ok excuse the bad handwriting/drawing but hope this conveys the basic idea of what we're after. This will be revised obviously but I think it's a good benchmark to work towards.

Let me know if you have any feedback!

Add github login

Using PassportJS, users should be able to log into their accounts to see their snippets.

Come up with a name + logo!

Ok so CodeSnippets was just a placeholder really.

We need to come up with a new name - it doesn't necessarily have to be immediately to do with code or snippets (like 'Amazon' with shopping).

Associated with that name, comes a logo. So if you have a creative hat, then put it on and see what you can come up with. We'd be very welcome of ideas!

If you aren't one for design then we'd be more than happy for suggestions of names!