The British Council Induction

The main aim of this prototype is to give ideas for an implementation of a British Council Induction, and is not to provide a full working product.

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

To begin to use the induction program you must have npm installed. If you do not, download it here.

• NPM - Used to install the key dependencies needed to run the induction

Optional

• git - Needed if you want to clone the directory directly

Installing

1. First clone the repository.

git clone git@github.com:chrismphilp/bc-induction-website.git

2. Then, change or cd into the cloned directory.

cd bc-induction-website

3. Run the below command on the root of the directory.

npm install

4. Finally run this command.

npm start

Usage

This is a prototype of a potential British Council Induction program, and not a fully functional product. Therefore it is open-source, and contributions are welcome.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request!

Built With

• react - Used to structure the whole site
• react-router - Used to make the prototype a single-page application
• react-springy-parallax - Used to create the parallax scrolling effect

Authors

• Christopher Philp - Lead Developer - GitHub
• Kristen Carter - Lead Developer - GitHub

Screenshots

License

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