mct-dev / api

The ESFiddle API

ESFiddle API

The ESFiddle API used by the ESFiddle site (https://esfiddle.net) This project is a heavy work in progress. Please take a look at the issues, as this is a new project, there is lots of low hanging fruit, so dive in! We are looking for contributors and maintainers.

Setup

# Clone the repo
$ git clone [email protected]:esfiddle/api.git esfiddle-api

# Go into the repo
$ cd esfiddle-api

# Install the dependencies and build for the first time
$ npm i && npm run build

# Setup the environment
# The default values should work fine, but edit them in the .env to make any changes
$ cp .env.example .env

# Start the project!
$ npm start

# Test
$ npm test

Configuration

Create .env file in root directory using .env.example file.

Documentation

You can find our swagger documentation at https://api.esfiddle.net/docs

Contributing

Check our the contribution guide here: https://github.com/esfiddle/site/blob/master/docs/CONTRIBUTE.md