Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 5.34 KB

README.md

File metadata and controls

117 lines (83 loc) · 5.34 KB
Raw

Build Status Coverage Status Netlify Status

Hackton

A comprehensive portal for hackathons where students can submit their work and judges can evaluate in one place. It is an app that helps you organize and evaluate Hackathons.

  • Login image

  • Dashboard image

  • Hackathon Event image

  • Project Submissions image

  • User Profile image

Table of Content

  1. Getting started
  1. Running the tests
  1. Deployment
  2. Technology stack
  3. Contributing
  4. Versioning
  5. Authors
  6. License
  7. Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To get started with this project you need a basic knowledge of the following.

Javascript (ES6)
NodeJs
SQL (Postgres)
Version Control (Git)

Installation

  • After cloning the repository, in the project directory, cd into hackton-frontend and you can run: npm install or yarn install in the console.
  • Then run npm start or yarn start.

Enviroment Variables

The following should be inside .env file for the app to function correctly.

REACT_APP_API_URL='https://hackton-staging.herokuapp.com'

Running the tests

Run npm test or yarn test in the console.

Break down into end to end tests

  • EditHackathon test - renders the User EditHackathon template correctly
  • EventOnboarding test - renders the User EventOnboarding template correctly.
  • HackathonForm test - renders the User HackathonForm template correctly.
  • HackathonSingle test - renders the User HackathonSingle template correctly.
  • UserOnboarding test - renders the User UserOnboarding template correctly.
  • UserProfileForm test - renders the User UserProfileForm template correctly.

Deployment

  • The landing page was deployed with Zeit
  • The Actual site was deployed with Netlify

Technology Stack

  • React - The web framework used.
  • Redux-saga - State management tool.
  • Styled-components - Used to generate styles.
  • Formik - Component that helps with building forms
  • Moment - A free and open source JavaScript library that removes the need to use the native JavaScript Date object directly.
  • Coveralls - Ensure all code is covered by test suite.
  • Jwt-Decode - A library to decode jwt tokens.
  • Dotenv - A zero-dependency module that loads environment variables from a .env file into process.env.
  • Query-string - Used to retrieve the variable values in the HTTP query string.
  • Eslint - A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, with the goal of making code more consistent and avoiding bugs.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

This is version 0.0.3 (Release canvas 2)

Authors

  • Pascal Ulor - Team lead - github
  • Mariam Adedeji - Team member - github
  • Mike Perry Attara - Team member - github
  • Justinas Vebra - Team member - github
  • Mildred Otieno - Team member - github
  • Ayomide Jones - Team member - github

License

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

Acknowledgments

  • Lambda