Business Factory

Let's do business.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Acknowledgments

About The Project

This repository contains the source code for the Business Factory idle/incremental game.

Built With

• Expo

• Yarn

• React Native

• TypeScript

Getting Started

Below are instructions for setting up your development environment.

Prerequisites

• Install docker and docker-compose

• Determine your machine's local IP address

Installation

1. Clone the repo

   git clone https://github.com/Money-Factory/businessfactory.git

2. Add your local IP to .devcontainer/.env

   REACT_NATIVE_PACKAGER_HOSTNAME=<your-local-ip>

3. Run docker-compose to start the application

   docker-compose -f ./.devcontainer/docker-compose.yml up --build

4. Go to <your-local-ip>:19002 to view the developer tools. You can install the Expo Go app and scan the QR code to open on a mobile device

5. After you're done working and terminate the docker-compose proccess you can use the following to clean up the containers

   docker-compose -f ./.devcontainer/docker-compose.yml down

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b username/feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin username/feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL License. See LICENSE.md for more information.

Acknowledgments

A big thanks to all the authors of the projects that make this game possible.