README.md

everything

An all-in-one tool interacting with the inventory of everything.

Use App · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

everything is one of several applications to aid in the creation of the inventory of everything: a centralized database of real, tangible assets that can then be used as the foundation for decentralized marketplaces, services, tools-- in the effort to create a circular economy that makes sense for everyone.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/near-everything/app.git

2. Install NPM packages

   npm install

(back to top)

Usage

Make sure you have the everything-api running locally!

1. Run the app in development mode:

 npm run dev

2. Open http://localhost:3000 to view it in the browser.

   The page will reload if you make edits.
   You will also see any lint errors in the console.

3. When prompted (/login), login with any phone number, real or fake. This will be saved locally to the firebase emulator and will not be available for anyone else to see. Once you enter in your phone number and submit, check the docker logs for container "firebase-emulator:firebase-emulator" and there should be a message "To verify the phone number __, use the code ___". Enter in this code on the login page.

(back to top)

Roadmap

• TBD...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Elliot Braem - elliot@everything.dev

(back to top)

Acknowledgments

• README adapted from Best-README-Template.

(back to top)