Giter Club home page Giter Club logo

packstack's Introduction

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

Join us on Slack.

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 πŸ™‚

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

Roadmap

  • Coming soon
  • Coming soon
  • Coming soon

License

Apache 2.0

packstack's People

Contributors

maplethorpej avatar darinalleman avatar callisto13 avatar dependabot[bot] avatar atgardner avatar bebersohl avatar victorwyee 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.