Skip to content

Documentation updates #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
MatthewGidcomb wants to merge 5 commits into
base: development
Choose a base branch
from
Draft

Documentation updates #570

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6c7966c
Documentation updates
MatthewGidcomb Jun 12, 2026
c09999f
Remove a to-do list
MatthewGidcomb Jun 14, 2026
0e48a80
Fix email
MatthewGidcomb Jun 19, 2026
981e423
Update description of API server env file
MatthewGidcomb Jun 20, 2026
4d6db25
Update Codespace docs
MatthewGidcomb Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ The frontend web application served at [infinite.industries](https://infinite.in
[DEPLOY.MD](./DEPLOY.MD)


### Widget
### Widget (Unmaintained)

Can be embedded in partner websites and services.
[Widget Documentation](https://github.com/infinite-industries/infinite/tree/master/widget)

## Current Project Team Members

+ [Matthew Gidcomb](https://github.com/MatthewGidcomb)
+ [Becky Mead](https://github.com/rlmead)
+ [Summer Smith](https://github.com/summasmiff)
+ [Dima Strakovsky](https://github.com/Digi-D)
+ [Jason Swank](https://scalene.net/~jswank)
+ [Zoe Triantafilou](https://github.com/zoe-triantafilou)
Expand All @@ -52,8 +52,9 @@ Can be embedded in partner websites and services.

+ [Evan Heaton](https://github.com/epheat)
+ [Yevhen Lukin](https://github.com/dix-icomys)
+ [Becky Mead](https://github.com/rlmead)

Please contact us at info@infiniteindustries We will walk you through how to start running various components in your local dev environment.
Please contact us at [info@infiniteindustries](mailto:info@infiniteindustries). We will walk you through how to start running various components in your local dev environment.
Comment thread
MatthewGidcomb marked this conversation as resolved.
Outdated

## License

Expand Down
28 changes: 11 additions & 17 deletions api-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Backend API powering [Infinite Industries](https://infinite.industries).

## Features

- **TODO**: [refer to Project Page](https://github.com/infinite-industries/infinite/projects/1)

## Development Environment Setup

### Dependencies
Expand All @@ -17,28 +13,26 @@ You will need the following tools:
- [Postgres](https://www.postgresql.org/): 9.4.0 or higher
- [docker](https://www.docker.com)

Install dependencies:

```bash
$ cd api-server
$ npm install
```

### Setup

Set up the env file and add *1nfinite.pem* file to keys directory. Sample files are provided with a `.sample` suffix.
A core team member can send you the dev secrets via the Infinite Industries Slack.
Set up the env file. A sample file is provided with a `.sample` suffix.

@summasmiff summasmiff Jun 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a note that you don't actually need to do this unless you need specific dotenv variables like AWS stuff?


```bash
cp .env.sample .env
cp keys/1nfinite.pem 1nfinite.pem
```

## Installation

```bash
$ npm install
```

## running integration tests
### Set up Database

- put keys in the keys directory
- `npm run test:e2e`
The [docker-start-local-db.sh](./docker-start-local-db.sh) script will start a Postgres database in a Docker container with default database name and credentials. When started in dev mode, the API server will connect to this DB automatically.

## Running the app
## Running the App

```bash
# development
Expand Down
9 changes: 0 additions & 9 deletions api-server/todo.md
View file
Open in desktop

@MatthewGidcomb MatthewGidcomb Jun 14, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chriswininger I think the only part of this to-do list left to do is filtering by partner name, right?

@summasmiff summasmiff Jun 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on deleting this file!

This file was deleted.

6 changes: 1 addition & 5 deletions web-portal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Front-end web application for [Infinite Industries](https://infinite.industries).

## Features

- **TODO**: [refer to Project Page] (https://github.com/infinite-industries/infinite/projects/1)

## Development Environment Setup

### Dependencies
Expand Down Expand Up @@ -36,7 +32,7 @@ This application communicates with an [API server](https://github.com/infinite-i
2. Install dependencies

```bash
cd web-portal-nuxt
cd web-portal
npm install
```

Expand Down
Loading