Giter Club home page Giter Club logo

enmascript's Introduction

This repo contains the source code and documentation behind enmascript.com.

Prerequisites

  1. Git (for version management).
  2. Node: any 8.x or greater (I also recommend using NVM to manage multiple versions).
  3. Yarn: a very powerfull package manager, check Yarn's website to learn how to install it.
  4. You'll need to fork the repo and clone it locally if you want to contribute.

Installation

  1. Go to the folder cd enmascript.
  2. yarn install to install all the dependencies needed.

Running locally

  1. gatsby develop to start the development server (you may need sudo if you're a linux user).
  2. The site will start in http://localhost:8000.

Contributing

Guidelines

Contributing to the site is very simple.

Work in your changes

  1. git checkout master
  2. git pull origin master
  3. git checkout -b your-branch-name (use any descriptive name for your branch, not too long)
  4. Work in your changes.

Test your implementation

Once you have finished working on your changes, test the implementation by following the next steps:

  1. run gatsby build to generate a productive version of the site.
  2. run gatsby serve and check your changes on http://localhost:9000

Create a Pull Request

If after testing everything looks good you can proceed to create a pull request:

  1. Commit your changes and push them to your branch.
  2. Create a pull request pointing to the master branch on the main repo.
  3. Add the labels related to your Pull Request.

That's it, I'll be checking your changes shortly and if everything goes well and the changes make sense, I'll merge your pull request.

Troubleshooting

If you get problems when building the project try the following:

  • rm -rf .cache to remove the local cache.
  • rm -rf public to delete the public folder (it's generated when building the site).

enmascript's People

Contributors

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