Skip to content
Snippets Groups Projects
Commit 21e1362e authored by Peter Mangelsdorf's avatar Peter Mangelsdorf
Browse files

Add Installation Guide; Update Contributing with Script Notice; Update README with INSTALL link

parent fd246b53
No related branches found
No related tags found
No related merge requests found
...@@ -156,6 +156,11 @@ At the end of the day, we are guests to someone else's codebase. ...@@ -156,6 +156,11 @@ At the end of the day, we are guests to someone else's codebase.
You should learn whatever guidelines they have have and follow them. You should learn whatever guidelines they have have and follow them.
This is not a lot of text, but the implications are big, you must study how the external group writes their code. This is not a lot of text, but the implications are big, you must study how the external group writes their code.
One explicit requirement is to run some scripts before creating a pull request:
- `./manage.py test` (runs the test suite)
- `./manage.py lint` (runs the linter)
- `./manage.py format` (applies automatic code formatting on Python files)
Otherwise, we recommend taking the time to thoroughly *document* and *test* your code. Otherwise, we recommend taking the time to thoroughly *document* and *test* your code.
[JavaDocs](https://en.wikipedia.org/wiki/Javadoc) and [Unit tests](https://en.wikipedia.org/wiki/Unit_testing) are a good place to start. [JavaDocs](https://en.wikipedia.org/wiki/Javadoc) and [Unit tests](https://en.wikipedia.org/wiki/Unit_testing) are a good place to start.
......
# Installation
## 1. [Download Git](https://git-scm.com/downloads)
## 2. [Download Vagrant](https://www.vagrantup.com/downloads)
## 3. [Download VirtualBox](https://www.virtualbox.org/wiki/Downloads) or an equivalent compatible Virtual Machine System
## 4. Cleanup Line Endings (Windows Only)
Make sure you are in the `team-blue` directory and can see the `.git` directory before running this command.
```bash
git config core.autocrlf input
```
## 5. Launch Git Bash with Administrative Privileges (Windows Only) for any following commands
## 6. Clone the Team Repo
```bash
git clone --recurse-submodules git@gitlab.cci.drexel.edu:courseeval/team-blue.git se420-team-blue
```
## 7. Navigate to the EvaP Directory
```bash
cd se420-team-blue
cd EvaP
```
## 8. Activate Vagrant (and Apply Updates)
```bash
vagrant up
```
## 9. Activate Vagrant Connection
```bash
vagrant ssh
```
## 10. Launch the Server
```bash
./manage.py run
```
## 11. Access the Website
Open a browser to: http://localhost:8000/
login with:
```yaml
email: evap@institution.example.com
password: evap
```
## NOTE
[Read E-Valuation's README](https://github.com/e-valuation/EvaP/#installation) and [Installation Guide](https://github.com/e-valuation/EvaP/wiki/Installation) before beginning but ***DO NOT FOLLOW THEIR STEPS*** (Their steps download to a separate folder and will create problems later when you go to install).
...@@ -35,6 +35,8 @@ Please join us on [Discord](https://discord.gg/QKBxxSS9), we are largely focused ...@@ -35,6 +35,8 @@ Please join us on [Discord](https://discord.gg/QKBxxSS9), we are largely focused
We currently do a lot of work in *Microsoft Word* and *Markdown*, so having a Microsoft account and a decent text editor is recommendable. We currently do a lot of work in *Microsoft Word* and *Markdown*, so having a Microsoft account and a decent text editor is recommendable.
For code-related portions of the project, please consult the [`INSTALL`](INSTALL.md) and the [e-valuation GitHub](https://github.com/e-valuation/EvaP/) for how to run the software.
## Roadmap ## Roadmap
(MISSING) (MISSING)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment