Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.59 KB

README.md

File metadata and controls

57 lines (35 loc) · 1.59 KB

Theatre-Joker

Theatre-Joker is the interactive joker face made using TheatreJS.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need to install Node.js. After installing Node.js install yarn:

npm i -g yarn

Installing

A step by step series of examples that tell you how to get a development env running

First clone the repository:

git clone https://github.com/Alireza29675/theatre-joker.git

Then install packages:

cd theatre-joker
yarn install

After that, start the project using command below:

yarn start

you should see the joker at http://localhost:3000.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details