Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intersectmbo/govtool-voting-pillar
GovTool Voting Pillar Packages
https://github.com/intersectmbo/govtool-voting-pillar
Last synced: about 1 month ago
JSON representation
GovTool Voting Pillar Packages
- Host: GitHub
- URL: https://github.com/intersectmbo/govtool-voting-pillar
- Owner: IntersectMBO
- Created: 2024-05-14T12:28:13.000Z (7 months ago)
- Default Branch: develop
- Last Pushed: 2024-10-23T16:53:21.000Z (2 months ago)
- Last Synced: 2024-10-23T23:49:54.295Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 5.51 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# 🚀 GovTool Voting Pillar 🚀
Welcome to the official repository for the GovTool Voting Pillar.
## Table of content:
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Tech stack](#tech-stack)
- [Getting started](#getting-started)
- [Running locally](#running-locally)
- [Running using docker compose](#running-using-docker-compose)
## Introduction
This document serves as a comprehensive guide for setting up the full stack of our application, which includes the backend, frontend, and database components.
## Prerequisites
- Node.js installed - [Download link](https://nodejs.org/en/download/).
- PostgreSQL installed (if running locally without Docker) - [Download link](https://www.postgresql.org/).
- Docker and Docker Compose installed (for Docker environment) - [Download link](https://docs.docker.com/get-started/)
## Tech stack:
[React](https://react.dev/)
[Typescript](https://www.typescriptlang.org/)
# Frontend
The frontend of the application is built using React, a popular JavaScript library for building user interfaces.
## Getting started
Before you begin setting up the application, you'll need to clone the repository from GitHub to get a local copy of the code. Follow these steps to clone the repository and start setting up the application components:
1. **Clone the Repository:**
- Open a terminal on your computer.
- Navigate to the directory where you want to store the project.
- Run the following command to clone the repository:
```
git clone https://github.com/IntersectMBO/govtool-voting-pillar.git
```
2. **Navigate to the Project Directory:**
- After cloning, change into the project's root directory:
```
cd govtool-voting-pillar
```
This directory contains all the files you need to set up the application.
By cloning the repository, you ensure that you have the latest version of the code and all the necessary files to get started with the application setup.
## Running locally
To run the application locally, you need to have Node.js installed.
1. **Install dependencies** by running `npm install`.
2. **Configure Environment Variables:** Create or edit a `.env` file in the frontend directory to include environment variables specific to application.
3. **Start the React Application** with `npm run dev` for development mode. This command serves your frontend application and hot-reloads for any changes.
## Running using docker compose
To run the application using Docker Compose, you need to have Docker and Docker Compose installed.
1. **Build the Docker Images:** Run `docker-compose build` to build the Docker images for the frontend and backend.
2. **Start the Application:** Run `docker-compose up` to start the application.