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

Jump to bottom

Backend dev env setup docs #14

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Backend dev env setup docs #14

wants to merge 6 commits into from

Conversation

limivann
Copy link

[SCSE-22]

@linear
Copy link

linear bot commented Oct 17, 2022

SCSE-22 Backend dev env setup docs

  • Install python 3.x
  • Install poetry
  • Install nvm & node.js (link to another doc for this)
  • Install serverless cli
  • Install dynamodb offline

Remember to add the following

  • reminder to update zshrc/bash_profile/path with poetry path (mac/linux/windows)
  • use nvm to switch between versions of node.js across projects

@vercel
Copy link

vercel bot commented Oct 17, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
docs ✅ Ready (Inspect) Visit Preview Oct 25, 2022 at 1:35AM (UTC)

@limivann limivann changed the title New commit Backend dev env setup docs Oct 17, 2022
@limivann limivann marked this pull request as draft October 17, 2022 15:26
limivann and others added 3 commits October 20, 2022 22:31
@limivann @ztjhz
New commit [SCSE-22]
a510bb5
@ztjhz
docs: add python installation instructions
4d4eced 
This commit adds the python installation instruction for
windows, macos, and linux to the backend dev environment setup page.

[SCSE-22]
@ztjhz
docs: add peotry instruction + restructure docs
543f903 
This commits adds the peotry instruction for windows, macos, and linus
to the backend dev environment setup page.
It also restructures the backend dev environment setup page.

[SCSE-22]
@ztjhz
docs: add serverless cli and dynamodb offline
11e2dba 
This commit adds documentation for installing serverless cli and
dynamodb offline

[SCSE-22]
@ztjhz ztjhz marked this pull request as ready for review October 20, 2022 15:02
@ztjhz ztjhz requested a review from RealDyllon as a code owner October 20, 2022 15:02
RealDyllon
RealDyllon requested changes Oct 24, 2022
View reviewed changes
Copy link
Member

@RealDyllon RealDyllon left a comment

Choose a reason for hiding this comment

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

Looks good, just needs 2 changes:

  1. rename all instances (in file names and file content) of peotry to poetry

  2. Instead of running dynamodb inside java locally, let's use this: https://www.serverless.com/plugins/serverless-dynamodb-local

ztjhz added 2 commits October 25, 2022 09:13
@ztjhz
docs: fix typo from peotry to poetry
31cba15 
This commit renames all instances (in file names and file content) of
peotry to poetry
[SCSE-22]
@ztjhz
docs: update DynamoDB installation instruction
9c94a49 
This commit updates the DynamoDB installation instruction from
running it locally inside Java to running it with
the serverless-dynamodb-local plugin
[SCSE-22]
@ztjhz ztjhz requested a review from RealDyllon October 25, 2022 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RealDyllon RealDyllon Awaiting requested review from RealDyllon RealDyllon is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@limivann @RealDyllon @ztjhz