Skip to content
This repository has been archived by the owner on Feb 7, 2023. It is now read-only.

Commit

Permalink
Merge pull request #132 from swarmion/docs/install
Browse files Browse the repository at this point in the history
docs: update installation doc
  • Loading branch information
fargito authored Mar 25, 2022
2 parents 8442f97 + 15979db commit 570c072
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ This section supposes that you already have an active AWS account.

If you only want to run the example, you can skip this section.

If you want to take is as an example to start your own projet,
If you want to take is as an example to start your own project,

- Go to [the shared configuration file](../packages/serverless-configuration/sharedConfig.ts);
- Change the `projectName` variable to the name of your project (note that this name must not be too long);
- Change the dev profile name to one that suits you;
- Search and replace "swarmion-starter" and replace it with the same project name
- Rename the `swarmion-starter.code-workspace` file at the root of the project to `<projectName>.code-workspace`

## Install modules

Expand All @@ -45,7 +46,7 @@ In order to deploy the stack on a development environment, you will need to setu
- Click on the "Attach existing policy directly", then select "AdministratorAccess" and click on "Next: tags";
- Click "Next: review", then "Create user";
- Do not close the window yet;
- Open a terminal and run: `aws configure --profile <your-profile>` (the value of `<your-profile>` depends of your choice in [the personalisation section](#change-the-project-general-settings). By default it will be `swarmion-starter-developer`);
- Open a terminal and run: `aws configure --profile <your-profile>` (the value of `<your-profile>` depends of your choice in [the personalization section](#change-the-project-general-settings). By default it will be `swarmion-starter-developer`);
- Fill in the Access Key Id and the Secret Access Key from your user;
- For the region, use the AWS region chosen for your project. See [the list of AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/).

Expand Down

0 comments on commit 570c072

Please sign in to comment.