Giter VIP home page Giter VIP logo

relevantindependent's Introduction

Relevant Independent README.

Overview

Why does Relevant Independent exist?

I wanted to make a website containing news and reviews for independent video games.

What does the code do?

The code will allow users to view reviews, after registering with a username and password.

Features

Existing Features

  • ability to register, in order to unlock reviews

Features Left to Implement

  • User Based Features

    • Email registration
    • Login/out
  • Site Features

    • Many reviews planned to put up
    • News section planned
    • Possible forum section in the future

Contributing:

Please feel free to contribute! You can find me under alexmiller64 on github, and the project under relevantindependent. Please feel free to make any changes or additions you see fit, then submit a pull request.

Getting the code up and running

  1. Firstly you will need to clone this repository by running the git clone <project's Github URL> command
  2. After you've that you'll need to make sure that you have npm and bower installed
  3. You can get npm by installing Node from here
  4. Once you've done this you'll need to run the following command: npm install -g bower # this may require sudo on Mac/Linux
  5. Once npm and bower are installed, you'll need to install all of the dependencies in package.json and bower.json
npm install

bower install
  1. After those dependencies have been installed you'll need to make sure that you have http-server installed. You can install this by running the following: npm install -g http-server # this also may require sudo on Mac/Linux
  2. Once http-server is installed run http-server
  3. The project will now run on localhost
  4. Make changes to the code and if you think it belongs in here then just submit a pull request

Tech Used

Some of the tech used includes:

  • AngularJS
    • We use AngularJS to handle page routing, we also use it to make calls to the REST API and build custom directives
  • Bootstrap
    • We use Bootstrap to give our project a simple, responsive layout
  • npm
    • We use npm to help manage some of the dependencies in our application
  • bower
    • Bower is used to manage the installation of our libraries and frameworks

Validation:

All relevant code has been run through a Markup Validation service here: https://validator.w3.org/check

Built with:

  • Bootstrap - Framework used
  • HTML5, JavaScript, CSS - Syntaxes used

Author:

Alex Miller

Acknowledgements:

  • Matt Rudge (Tutor at Code Institute) - for guidance and advice
  • Staff at Code Institute - for lessons on which Relevant Independent is based. Also for "getting the code up and running" section and "Tech Used/Some of the tech used includes" section of this README.

relevantindependent's People

Contributors

alexmiller64 avatar

Watchers

James Cloos avatar Yoni Lavi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.