Skip to content
This repository was archived by the owner on Mar 27, 2023. It is now read-only.

Commit e9d6623

Browse files
committed
removed old documentation, added new documentation
1 parent 6195e58 commit e9d6623

File tree

16 files changed

+513
-4579
lines changed

16 files changed

+513
-4579
lines changed

README.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,10 @@ Documentation for this project can be found here:
44

55
[https://verbose-equals-true.gitlab.io/django-postgres-vue-gitlab-ecs/](https://verbose-equals-true.gitlab.io/django-postgres-vue-gitlab-ecs/)
66

7-
## Architecture
8-
9-
![png](/architecture.png)
10-
117
## Local Development
128

139
First, copy `.env.template` to a new file in the project's root directory called `.env`. This file will be read by `docker-compose` in the next step. Adjust any of the values in this file if needed, or add new variables for any secret information you need to pass to docker-compose (or to docker containers).
1410

15-
## Current Project Goals
16-
17-
Currently I am working on replacing CloudFormation with CDK for infrastructure and deployment.
18-
19-
To work with CDK, do the following:
20-
21-
- Make sure you are using at least version 10 of node: `nvm use 13`
22-
- Activate the virtual environment with `source awscdk/.env/bin/activate`
23-
- `pip install -e awscdk` to install CDK dependencies
24-
- run `cdk synth --app awscdk/app.py --output awscdk/cdk.out` and view the resulting JSON for the nested CloudFormation stacks in `awscdk/cdk.out`
25-
2611
### Social Authentication Keys
2712

2813
To use social sign on in development, you will need to create an application with the given provider.
@@ -39,7 +24,7 @@ Go to [https://github.com/settings/applications/new](https://github.com/settings
3924
In the `.env` file, add the `Client ID` of your GitHub OAuth App as the `GITHUB_KEY` variable, and add the `Client Secret` as the `GITHUB_SECRET` variable.
4025

4126
```sh
42-
docker-compose up --build
27+
docker-compose up
4328
```
4429

4530
Open `http://localhost` in your browser.
@@ -71,12 +56,3 @@ or use this single command:
7156
```
7257
docker exec -it backend bash -c 'cd notebooks && ../manage.py shell_plus --notebook'
7358
```
74-
75-
# ToDo
76-
77-
- Add diagram of local development
78-
- Put django apps in apps folder
79-
- Redeploy django app to check settings files
80-
- Add GitLab pages site for Group project
81-
- Add file upload examples with Django REST Framework
82-
- Setup password reset

documentation/docs/.vuepress/config.js

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,30 +36,9 @@ module.exports = {
3636
{ text: "Tools Used", link: "/start/tools/" },
3737
],
3838
},
39-
{
40-
text: "Guide",
41-
items: [
42-
{ text: "Testing", link: "/guide/testing/" },
43-
{ text: "Project Setup", link: "/guide/project-setup/" },
44-
{ text: "Backend API", link: "/guide/django-rest-framework/" },
45-
{ text: "Vue App", link: "/guide/vue-app/" },
46-
{
47-
text: "Connecting Backend & Frontend",
48-
link: "/guide/connecting-backend-frontend/",
49-
},
50-
{ text: "NGINX", link: "/guide/nginx/" },
51-
{ text: "Celery & Redis", link: "/guide/celery-and-redis/" },
52-
{
53-
text: "Production Environment",
54-
link: "/guide/production-environment/",
55-
},
56-
{ text: "Vue Authentication", link: "/guide/vue-authentication/" },
57-
],
58-
},
5939
{
6040
text: "DevOps",
6141
items: [
62-
{ text: "AWS", link: "/devops/aws/" },
6342
{ text: "AWS CDK", link: "/devops/aws-cdk/" },
6443
{ text: "GCP", link: "/devops/gcp/" },
6544
],
@@ -69,14 +48,8 @@ module.exports = {
6948
items: [
7049
{ text: "GraphQL", link: "/topics/graphql/" },
7150
{ text: "Minikube", link: "/topics/minikube/" },
72-
{ text: "Helm", link: "/topics/helm/" },
7351
],
7452
},
75-
{
76-
text: "Source Code",
77-
link:
78-
"https://gitlab.com/verbose-equals-true/django-postgres-vue-gitlab-ecs",
79-
},
8053
],
8154
},
8255
};
129 KB
Loading

0 commit comments

Comments
 (0)