1
0
mirror of https://github.com/matt-fidd/stratos.git synced 2026-01-01 16:19:26 +00:00

Add new readme

This commit is contained in:
2022-04-19 01:30:47 +00:00
parent e920f63e0c
commit 65c72070fd

128
README.md
View File

@@ -1 +1,127 @@
# stratos
<div id="top"></div>
<!-- PROJECT SHIELDS -->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/matt-fidd/stratos">
<img src="public/assets/logo-stacked.svg" alt="Logo" width="120">
</a>
<h3 align="center">Stratos Exam Tracker</h3>
<p align="center">
This is my A Level Computer Science Project for the OCR NEA component
<br />
·
<a href="https://github.com/matt-fidd/stratos/issues">Report Bug</a>
·
<a href="https://github.com/matt-fidd/stratos/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
<!--[![Product Name Screen Shot][product-screenshot]](https://example.com)-->
<p align="right">(<a href="#top">back to top</a>)</p>
### Built With
* [Node.js](https://nodejs.org/)
* [Express.js](https://expressjs.com/)
* [Handlebars](https://handlebarsjs.com/)
* [SASS](https://sass-lang.com/)
* [Jest](https://jestjs.io/)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/matt-fidd/stratos.git
```
2. Install NPM packages
```sh
npm install
```
3. Run gulp script to help set up config files
```sh
gulp
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Project Link: [https://github.com/matt-fidd/stratos](https://github.com/matt-fidd/stratos)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/matt-fidd/stratos.svg?style=for-the-badge
[contributors-url]: https://github.com/matt-fidd/stratos/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/matt-fidd/stratos.svg?style=for-the-badge
[forks-url]: https://github.com/matt-fidd/stratos/network/members
[stars-shield]: https://img.shields.io/github/stars/matt-fidd/stratos.svg?style=for-the-badge
[stars-url]: https://github.com/matt-fidd/stratos/stargazers
[issues-shield]: https://img.shields.io/github/issues/matt-fidd/stratos.svg?style=for-the-badge
[issues-url]: https://github.com/matt-fidd/stratos/issues
[license-shield]: https://img.shields.io/github/license/matt-fidd/stratos.svg?style=for-the-badge
[license-url]: https://github.com/matt-fidd/stratos/blob/master/LICENSE.txt