/ironhub-app

An Angular 2 front-end app, built in 2 weeks as the last project of Ironhack Barcelona bootcamp

Primary LanguageTypeScriptMIT LicenseMIT

ironhub

A single page application, based on the MEAN stack, that was initially built in two weeks as my last project of the one week of pair programming, as part of the Ironhack Web Development Bootcamp in Barcelona (at the end of module 3, weeks 8 and 9 of the program).

Ironhub's MVP includes a directory of Ironhack students and a directory of student projects. The goal of the project is for people at Ironhack (staff, teachers, TAs and students) to have a central place to get people's information and projects.

There are still a lot of things to implement and improve. All is listed in a Trello board I can share.

Finally, the project is deployed to Heroku and can be accessed here.

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

  1. Have Node.js installed. Please see here for more installation instructions.

Installing

Ironhub is made of two different repositories:

  1. The APP: ironhub-app
  2. The API: ironhub-api

To install the APP

  1. Download the .zip package or clone the project to your local machine
  • If you download the .zip file, please extract it to a local directory on your machine
  1. Run the 'npm install' command in your terminal
  2. Start the app by running the following command line in a terminal: 'ng serve'. The app will automatically reload if you change any of the source files.
  3. Make sure you have the Ironhub API already installed and running locally

You are now good to go. You can access the app locally in your web browser at the following URL: http://localhost:4200/

Build

This project was generated with Angular CLI version 1.2.3.

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Deployment

The app is deployed to Heroku and is accessible here. Please contact us for deploying new contributions.

Built With

  • Angular 2 - as the front-end framework
  • Bulma - as the CSS framework based on Flexbox
  • Font Awsome - used for displaying quality icons on any screen resolution and size

Code Quality

DeepScan Grade

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

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

License

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

Acknowledgments

  • Thanks to Tair Assimov, our module 3 teacher and TAs’ support during this intense weeks 8 and 9.
  • Thanks to everyone at Ironhack who contributed to the UX study I made for this project