Skip to content

Commit d5ad797

Browse files
authored
Merge pull request #932 from bounswe/dev
Dev to Master
2 parents 841913d + c6ad57a commit d5ad797

File tree

261 files changed

+25656
-7402
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

261 files changed

+25656
-7402
lines changed
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Learnify Source Code
2+
3+
## Running Docker Compose Instructions
4+
5+
### Environment Files
6+
7+
#### Backend
8+
9+
Go to backend folder and create a .env file
10+
Your .env file shall include:
11+
12+
JWT_KEY: key to be used for jwt tokens generation.
13+
MAIL: mailaddress the API uses, currently only gmail is supported.
14+
MAIL_PASS: application password of MAIL, please refer to : https://support.google.com/mail/answer/185833?hl=en
15+
16+
You can contact us for getting MAIL and MAIL_PASS used for our Milestone 1 presentation.
17+
18+
#### Semantic server
19+
20+
You should add API key used for semantic analysis API, please contact us for the required .env file.
21+
22+
#### Frontend
23+
24+
No environment files are required.
25+
26+
### Getting the server up
27+
28+
`docker compose up` command will get our frontend and backend clients up and running on your local.
29+
30+
## Running our APK
31+
32+
Please refer to the [System Manual](https://github.com/bounswe/bounswe2022group2/wiki/System-Manual) for getting our APK running.
33+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env.development.local
77+
.env.test.local
78+
.env.production.local
79+
.env.local
80+
81+
# parcel-bundler cache (https://parceljs.org/)
82+
.cache
83+
.parcel-cache
84+
85+
# Next.js build output
86+
.next
87+
out
88+
89+
# Nuxt.js build / generate output
90+
.nuxt
91+
dist
92+
93+
# Gatsby files
94+
.cache/
95+
# Comment in the public line in if your project uses Gatsby and not Next.js
96+
# https://nextjs.org/blog/next-9-1#public-directory-support
97+
# public
98+
99+
# vuepress build output
100+
.vuepress/dist
101+
102+
# vuepress v2.x temp and cache directory
103+
.temp
104+
.cache
105+
106+
# Docusaurus cache and generated files
107+
.docusaurus
108+
109+
# Serverless directories
110+
.serverless/
111+
112+
# FuseBox cache
113+
.fusebox/
114+
115+
# DynamoDB Local files
116+
.dynamodb/
117+
118+
# TernJS port file
119+
.tern-port
120+
121+
# Stores VSCode versions used for testing VSCode extensions
122+
.vscode-test
123+
124+
# yarn v2
125+
.yarn/cache
126+
.yarn/unplugged
127+
.yarn/build-state.yml
128+
.yarn/install-state.gz
129+
.pnp.*
130+
131+
# Ignore files related to API keys
132+
133+
# Ignore IDE specific directories
134+
.vscode
135+
.idea
136+
137+
# Ignore files/folders macOS could create in the directory
138+
.DS_Store
139+
.AppleDouble
140+
.LSOverride
141+
.DocumentRevisions-V100
142+
.fseventsd
143+
.Spotlight-V100
144+
.TemporaryItems
145+
.Trashes
146+
.VolumeIcon.icns
147+
.com.apple.timemachine.donotpresent
148+
._*
149+
150+
# Visual Studio Code related
151+
.classpath
152+
.project
153+
.settings/
154+
.vscode/*
155+
!.vscode/settings.json
156+
!.vscode/tasks.json
157+
!.vscode/launch.json
158+
!.vscode/extensions.json
159+
.history
160+
161+
# General
162+
.DS_Store
163+
.AppleDouble
164+
.LSOverride
165+
166+
# Icon must end with two \r
167+
Icon
168+
169+
# Thumbnails
170+
._*
171+
172+
# Files that might appear in the root of a volume
173+
.DocumentRevisions-V100
174+
.fseventsd
175+
.Spotlight-V100
176+
.TemporaryItems
177+
.Trashes
178+
.VolumeIcon.icns
179+
.com.apple.timemachine.donotpresent
180+
181+
# Directories potentially created on remote AFP share
182+
.AppleDB
183+
.AppleDesktop
184+
Network Trash Folder
185+
Temporary Items
186+
.apdisk
187+
188+
# Miscellaneous
189+
*.class
190+
*.lock
191+
*.log
192+
*.swp
193+
.atom/
194+
.buildlog/
195+
.svn/
196+

0 commit comments

Comments
 (0)