Skip to content
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

Update Website README #386

Merged
merged 2 commits into from
May 7, 2024
Merged

Update Website README #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9155694
Altered documentations to include new environment files and also upda…
jahn18 May 6, 2024
5caef88
Add Jordan as codeowner for website
jahn18 May 6, 2024
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@
/src/network_systems @hhenry01

# website
/src/website @jahn18
/src/website @JordanChen123
7 changes: 4 additions & 3 deletions src/website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Website

In the website development timeline, we are currently evaluating the folllowing software stack:
[Next.js](https://nextjs.org/) website (this repository) and the [MongoDB](https://www.mongodb.com/) database.
[Next.js](https://nextjs.org/) website (this repository), [Typescript](https://www.typescriptlang.org/docs/),
[React](https://react.dev/) + [Redux](https://redux-saga.js.org/), and the [MongoDB](https://www.mongodb.com/) database.
The easiest way to evaluate these potential solutions for our purposes is in [sailbot_workspace](https://github.com/UBCSailbot/sailbot_workspace).

## Database
Expand All @@ -13,8 +14,8 @@ developers and for the cloud era. If you want to learn more about MongoDB, visit

### Environment variables

This project uses environment variables to manage configuration-specific information. Please look at the file
`.env.local` and ensure the variables are defined below:
We have two separate configurations: one for development `.env.development`,
the other for production `.env.production`. The values may vary, but the environment variables are the same. See below:

- `MONGODB_URI`: Your MongoDB connection string. Use `mongodb://localhost:27017/<DB_NAME>` to establish a connection
with the local database.
Expand Down