amilookup.com

This repo is amilookup.com front end code.

amilookup.com-infra back end code here: https://github.com/AMILookup/amilookup.com-infra

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

What things you need to install the software and how to install them

Give examples

Installing

This section needs more work

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

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

This section needs more work

Currently we do not have any automated tests. However things like linters will be introduced in the future.

Break down into end to end tests

Explain what these tests test and why

Give an example

Deployment

Deployments are 100% handled by CircleCI. The deployment configuration file is here.

Built With

• CircleCI - The CI/CD tool used.
• SASS - The CSS Extension language used.

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.

Authors

• Alex Jackson - Primary Contributor - ajack764
• Andrew Jackson - Secondary Contributor - lordmuffin

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

License

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

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc