petemcw / packstack

Gear management and packing list generator for backpackers

Home Page:https://packstack.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Packstack

Packstack makes it easy for backpackers to plan their expeditions. At its core, Packstack features a flexible, versatile gear inventory management system that makes building packing lists simple.

Packstack is built with React, Typescript, NodeJS, Docker and Postgres.

The latest release can be found at Packstack.io

Getting started

Prerequisites

  • Git
  • Docker
  • Yarn

Install

  • Clone the repo: git clone https://github.com/maplethorpej/packstack.git
  • Navigate to project root: cd packstack
  • Copy and rename docker-compose-example.yml to docker-compose.yml
    • change configuration if desired
  • Build project: docker-compose up --build
  • In a new terminal window, install backend packages: cd api && yarn install
  • Copy and rename: api/config/config-example.json to api/config/config.json
    • change configuration if desired
  • Seed categories: yarn run seed:dev
  • Install frontend packages: cd ../frontend/ && yarn install
  • Create a .env file and add the following line:
    • REACT_APP_API_DEV="http://127.0.0.1:3000/api/v1/"
  • Start the dev environment: yarn start
  • View the project locally at localhost:3001
  • ๐ŸŽ‰๐Ÿ™Œ๐Ÿค˜๐Ÿ™Œ๐ŸŽ‰

Note: To stop docker, find the terminal running docker, press CTRL+C and run docker-compose down.

Contributing

If youโ€™re interested in contributing to Packstack, thank you! โ€“ thereโ€™s much yet to be done ๐Ÿ™‚

To contribute, you can either choose one of the roadmap features to work on or develop your own feature.

Learn more about contributing, and make sure to read our Code of Conduct.

Roadmap

  • Coming soon
  • Coming soon
  • Coming soon

License

Apache 2.0

About

Gear management and packing list generator for backpackers

https://packstack.io

License:Apache License 2.0


Languages

Language:TypeScript 61.7%Language:JavaScript 36.8%Language:CSS 0.9%Language:HTML 0.4%Language:Dockerfile 0.3%Language:Shell 0.1%