atmos-adventure

KO | EN

gitlite — search

#javascript #python #react #go #golang #docker #macos #nodejs #cli #kubernetes #vue #openai #mcp #open-source

atmos-adventure

(★ 23)

This repository is about our final school project (2021-2022)! In this repo you can find the source code for our adventure-themed game and website.

atmos-adventure Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Team ATMOS</h1>

## 💻 About

This repository contains our submission for the final 2021-2022 project - "The Games - Adventure"!
You can find out more about our modern web app & our Unity game!

## 🗂️ Our Tech Stack

### Used code editor & collaborative service:

### Used tools for our visual elements:

### Used tools for our frontend development:

### Used technologies for our backend development:

### Used tools for our game development:

### Used tools for our documentation, presentation & communication:

<hr>

## 📄 Documents

### QA Documentation

- [Test Plan](https://github.com/codingburgas/2122-the-games--adventures-atmos-final-project-2022/raw/main/docs/Atmos%20-%20Test%20plan.docx)
- [QA Documentation](https://github.com/codingburgas/2122-the-games--adventures-atmos-final-project-2022/raw/main/docs/Atmos%20-%20client%20QA%20Doc.xlsx)

### Code & Team Documentation

- [Jupyter Notebook](https://docs.atmos.systems)
- [Team Documentation](https://github.com/codingburgas/2122-the-games--adventures-atmos-final-project-2022/raw/main/docs/Atmos%20-%20Documentation.docx)

### Presenting

- [Presentation](https://github.com/codingburgas/2122-the-games--adventures-atmos-final-project-2022/raw/main/docs/Atmos%20-%20Presentation.pptx)

<hr>

## 📥 Installation

You can view our Jupyter Notebook by visiting <a href="https://docs.atmos.systems">this</a> link! 
 
If you want to clone our repo locally you can paste the following command in your preferred terminal:

<pre>https://github.com/codingburgas/2122-the-games--adventures-atmos-final-project-2022</pre>

<hr>

<h3>🖥 Client</h3>
Then, you can launch the web application by following these commands:

1. Navigate to our client folder using:
<pre>cd client</pre>
2. Install the node modules using:
<pre>npm install</pre>
3. Run the development server using:
<pre>npm run dev</pre>

<h3>🌎 Server</h3>
You will need another terminal to launch the server, paste the following commands:

1. Navigate to our server folder using:
<pre>cd server</pre>
2. Install the node modules using:
<pre>npm install</pre>
3. Create .env file for the DB by using the following example
<pre>
DB_HOST = &ltDATABASE IP&gt
DB_NAME = &ltDATABASE NAME&gt
DB_USERNAME = &ltDATABASE USERNAME&gt
DB_PASSWORD = &ltDATABASE PASSWORD&gt
EMAIL_HOST = &ltEMAIL IP&gt
EMAIL_USERNAME = &ltEMAIL&gt
EMAIL_PASSWORD = &ltEMAIL PASSWORD&gt
</pre>
4. Run the development server using:
<pre>npm run dev</pre>
</pre>

<hr>

### 📓 Jupyter Notebook
If you want to run our Jupyter Notebook documentation locally, you will need Python 3.9+ installed on your machine, then you can run the following commands:
 
1. Upgrade pip for later usage:
<pre>pip3 install --upgrade pip</pre>
2. Install Jupyter Notebook via Python:
<pre>pip3 install jupyter</pre>
3. Install the NodeJS kernel:
<pre>npm install -g ijavascript</pre>
4. Run the kernel:
<pre>ijsinstall</pre>
5. Navigate to the notebook folder using:
<pre>cd notebook</pre>
6. Run the notebook using the following command:
<pre>jupyter notebook</pre>

### ✔ OPTIONAL:
You may want to style our documentation even more. To do this, just **paste these two commands after step №4**: 
4.1 Go to the `notebook` folder, in case you weren't there already and install the *Jupyter Notebook* theme packages:
<pre>python -m pip install jupytertheme</pre>
4.2 Upgrade the theme packages:
<pre>python -m pip install --upgrade jupytertheme</pre>
4.3 Use the list command in the newly installed theme package:
<pre>jt -l</pre>
4.4 Pick out a theme and apply it by pasting this line:
<pre>jt -t *your theme of choice*</pre>
 
4.5. If you have followed this optional guide, you can just resume with option №5 and option №6.

<hr>

### 📑 Notes:
NOTE: You can apply a different theme just by running the command above again with a different theme.
 
NOTE: You can remove your theme by running: <pre>jt -r</pre>
 
NOTE: Any additional changes to the styling can be made locally by referencing <a href="https://github.com/dunovank/jupyter-themes#description-of-command-line-options">the official jupyter themes documentation</a>!

<hr>

## 🧒 Our Team

- <a href = "https://github.com/NDPeshev19"> Nikola Peshev </a> (Scrum trainer)
- <a href = "https://github.com/BNSavov19"> Boris Savov </a> (Scrum Trainer/Backend Developer)
- <a href = "https://github.com/VTIvanov20"> Valeri Ivanov </a> (Designer)
- <a href = "https://github.com/MMMarinov20"> Maxim Marinov </a> (Frontend Developer)
- <a href = "https://github.com/SHHristov20"> Stefan Hristov </a> (Backend Developer)
- <a href = "https://github.com/DKByandov21"> Dimitar Byandov </a> (Designer)
- <a href = "https://github.com/MVKoleva21"> Mariya Koleva </a> (QA Engineer)
- <a href = "https://github.com/VDVichev21"> Vicho Vichev </a> (QA Engineer)

<hr>

<h1 align="center">Thanks for checking out our repo, show us some ❤️ by giving our repo a ⭐️!</h1>

atmos-adventure

atmos-adventure Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

atmos-adventure

atmos-adventure Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README