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.

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

MB-9609 migrate backend setup #30

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/backend/guides/guide-to-creating-an-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ sidebar_position: 14
---

# Creating an Endpoint

###### These are the various steps that are involved in creating a new endpoint.

Prior to creating an endpoint in the Handler folder, we must first add a new endpoint definition to swagger. We are using Swagger 2.0, which is [OpenAPI](https://swagger.io/specification/v2/), a specification we use to format our RESTful APIs and provide a template for us to communicate the information in our API.
Expand Down Expand Up @@ -280,3 +279,4 @@ var eventModels = map[KeyType]eventModel{


If you'd like to learn more about event triggers, you can find more details [here](https://github.com/transcom/mymove-docs/blob/720592c63db4bffe402a801417f7c14772573c28/docs/dev/contributing/backend/How-to-Add-an-Event-Trigger.md).

Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 3
---

# How To Backup and Restore the Development Database

## Backup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
id: index
slug: /help/
sidebar_position: 1
sidebar_position: 2
---

# Common Errors and Solutions

Having trouble running mymove locally? This page collects common errors and their solutions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 1
---

# Configure Postico or TablePlus to connect to mymove DB

If you prefer to use an app to view and update the DB, [Postico](https://eggerapps.at/postico/) and [TablePlus](https://www.tableplus.io/) are popular options.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 4
---

# How to Migrate the Database

If you need to change the database schema, you'll need to write a migration. These are the general steps you'll need to follow:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 5
---

# Run pre-commit hooks

[Pre-commit](https://pre-commit.com/) is a powerful tool that automates validations, lint checks and adds to developer quality of life. The config file that determines the actions of pre-commit hooks can be found [here](https://github.com/transcom/mymove/blob/master/.pre-commit-config.yaml).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_position: 6
---

# Using EagerPreload in Pop

## TOC

<!-- toc -->
Expand Down
6 changes: 6 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ module.exports = {
position: 'left',
label: 'About',
},
{
type: 'doc',
docId: 'backend/index',
position: 'left',
label: 'Backend',
},
{
type: 'doc',
docId: 'frontend/index',
Expand Down