Git Product home page Git Product logo

website's Introduction

Central place for ideas and designs for MooTools Projects.

Want to help, go to the Wiki and add your things.

Now there is something implemented already too. To start hacking follow the steps below:

Installation

To install everything you need to clone the repository and submodules (for the docs), install dependencies, build the documentation and run the server:

~$ git clone git://github.com/mootools/website.git
~$ cd website
~/website$ npm install
~/website$ node build/all
~/website$ node index

Notes:

  • Some dependencies use native C code which requires some compiler.
    • For Mac users this means that Xcode (Command Line Tools) should be installed.
    • For Windows you need python (2.7, and don't forget to add it you your %PATH%) and a C++ compiler like Visual Studio Express

Run it

To run it, you can either use node directly, use forever or use supervisor.

node index

Now the website is running on http://localhost:3000.

supervisor watches all files, while wrapup/stylus write to the public folder. It is advised to use supervisor --ignore public index.

Vagrant

If you don't want to install all node.js dependencies (and maybe later nginx), you can use Vagrant to get the same setup.

Once that's done you're only a vagrant up away of running everything automatically. The website should then be running on http://localhost:5001.

Like to help?

  • We need all websites for all projects, it needs to be easy, fast and done well.
  • Like to work with cool techniques like node, express, jade and stylus?
  • We also need great content and documentation.
  • All pages and navigation need to be fixed
  • Homepage needs to be transformed into html/css according to the design
  • Styling for different projects according designs
  • Adding sites for other projects: wrapup, moofx, agent
  • Integrate the wrapup-webbuilder better
  • Overall polish
  • So fork and send pull requests!

Folder structure

  • /index.js, is the main file, you can find everything from there
  • /views is where all the views and uncompiled js/css is
  • /public is where compiled css/js is saved. Also contains other things like images or fonts
  • /{prime,elements,agent,moofx} is where the routes of those projects are defined also the source files (markdown) of the guides/tutorials
  • /blog is where the routes and blogposts are stored
  • /{middleware,lib} are some library/helper modules
  • /tests is where some unit tests for some modules are located
  • /design contains some .ai files and other design specifications
  • /builder is for the wrapup web UI front-end
  • /build contains build scripts for the blog/guides and more
  • /cache is where the output of the build scripts is stored

Adding new release of project

node build/release [project] [tag]

this command should update the package.json configuration fields. After that doing as node build/all will clone the repository and build docs etc.

website's People

Contributors

andre-barata avatar arian avatar emehrkay avatar gcheung55 avatar ibolmo avatar pietrogregorini avatar sergiocrisostomo avatar timwienk avatar

Watchers

 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.