README.md

everything api

The GraphQL API to 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

The everything api is the interface 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

• 
• 
• 
• 
• through using Postgraphile

(back to top)

Getting Started

Prerequisites

Ensure you have these packages and tools installed on your machine before installing this project.

• npm

  npm install npm@latest -g

• Docker Desktop

Installation

1. Clone the repo

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

2. Install NPM packages

   npm install

(back to top)

Usage

1. Start docker - this will start and bootstrap the PostgreSQL database, pgAdmin web, and firebase emulators for authentication and storage

   npm run docker:up

2. Run the server:

   npm start dev

3. Explore:

Access to GraphiQL:

• http://localhost:4050/graphiql

TROUBLESHOOTING: Since GraphiQL authorization headers are not yet connected to firebase auth, you will need to comment out the token verification in index.ts pgSettings (comment out whole block) in order to successfully run queries

Access to PostgreSQL:

• localhost:5432
• Username: postgres (as a default)
• Password: changeme (as a default)

Access to pgAdmin:

• URL: http://localhost:5050
• Username: [email protected] (as a default)
• Password: admin (as a default)

pgAdmin can also be accessed via the desktop app, which can be downloaded here.

(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 - [email protected]

(back to top)

Acknowledgments

• Postgres, PgAdmin, docker setup referenced from compose-postgres.

(back to top)