https://github.com/hackafro/hey-polls
Demo project for creating and collecting polls
https://github.com/hackafro/hey-polls
Last synced: about 1 month ago
JSON representation
Demo project for creating and collecting polls
- Host: GitHub
- URL: https://github.com/hackafro/hey-polls
- Owner: HackAfro
- Created: 2020-04-03T15:59:50.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T18:25:15.000Z (over 3 years ago)
- Last Synced: 2025-01-14T14:12:04.222Z (over 1 year ago)
- Language: CSS
- Homepage: https://hey-polls.now.sh/
- Size: 4.04 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Polls Application
This repository contains the code for the Polls application.
## Tools used
The application is built using Javascript. The application uses React and was bootstrapped using Create React App.
The full list of tools used by the application can be found below:
- [React](https://reactjs.org) - tooling for frontend development
- [React Router](https://github.com/ReactTraining/react-router#readme) - router library
- [React Feather](https://github.com/feathericons/react-feather#readme) - Icon pack
- [React Modal](https://github.com/reactjs/react-modal) - Modal library
## Getting up and running
- Clone the repository
- Inside the cloned directory, run the following commands:
- `npm install` or `yarn` - To install all the project's dependencies.
- Run `yarn start` or `npm start` to start the frontend application
## Project directory
The project directory houses the server application and the frontend application.
- The frontend application - `./src`
The reusable components that make up the frontend application can be found in the `src/components` directory. Each component serves a single purpose:
- `./src/components/header` - renders the application header
- `./src/components/question-list` - renders list of questions
- `./src/components/question-detail` - this component displays details of a question and provides interface for voting
- `./src/components/modal` - renders a dialog
Asides from the components directory, the other existing directories are:
- `./src/contexts`: holds created context to manage app wide state
- `./src/providers`: renders the context file and provides helper methods for updating the state
## Styling
Styling was done using utility classes provided by [TailwindCSS](https://tailwindcss.com/) and some custom styles. Responsiveness was achieved using a [mobile first approach](https://tailwindcss.com/docs/responsive-design#mobile-first)