Merge pull request #41 from Slugbotics/develop

Version 1.0 to Master

README.md

@@ -2,3 +2,54 @@
 This repository will hold the source code for the iOS client for the Sluggo
 issue tracker. It is currently beign developed for CSE 115A at UCSC, and will
 eventually expand into a fully maintained frontend for the Sluggo project.
+
+# NOTE: ALL DOCUMENTATION FOR CSE115A RESIDES WITHIN THE [docs](doc/) FOLDER AT THE ROOT OF THIS PROJECT.
+
+## About Sluggo
+Sluggo is an open source Issue Tracker for companies, teams, and more. The software is selfhosted, and decentralized in a way that any team can spin up their own instance in minutes! This software is broken into two main parts: the [Django REST Application](https://github.com/Slugbotics/Sluggo-API) as the backend and the Sluggo iOS app as a front end.
+
+## Installing the API:
+1) Before using the Sluggo iOS application, make sure to install the backend API following the instructions on the [repository here](https://github.com/Slugbotics/Sluggo-API).
+2) After completing the installation process, proceed to the admin dashboard (default `127.0.0.8:8000/admin`) and sign on with your super user account that you just created.
+3) In this page, you will be able to create a record for your Team by selecting `Team` on the admin page, and hitting the `Add Team` button in the top right. Just give the team a name and hit save.
+4) Finally, after creating your team go through the same process and create a `Member` record for yourself on the Member page through the `Add Member` button on your top right. Set you user role as admin, select your team, and fill out any optional fields such as pronouns or Bio, then hit save.
+
+
+## SwiftLint and Coding Standards
+The development of Sluggo uses SwiftLint to standardize all changes and coding styles, if you are contributing to Sluggo, please follow the installation instructions for SwiftLint [here](https://github.com/realm/SwiftLint).
+
+In addition, all coding standards and acceptance tests reside within the [documentation folder](doc/), these standards are required to be followed before contributing to the project.
+
+## Installing the Application
+1) Clone this repository on a Mac device with Xcode installed.
+    - Preferably this is on the same device as the API. Otherwise, you must have the API acessable on your network with a public IP.
+3) Open the repository in Xcode, and select build.
+4) After this, your app is ready to run, configure your device and then select Run.
+    - If you have an apple device you would like to test on, follow [Apple's instruction on running apps on your phone](https://developer.apple.com/documentation/xcode/running-your-app-in-the-simulator-or-on-a-device).
+    - Otherwise you may use one of the built in simulators on XCode
+
+
+## Creating Users
+New users (*for now*) must be created through the admin dashboard similarily to the admin user. As the Sluggo ecosystem progresses, this will be adjusted, but it is now the job of the Sysadmin to create accounts for every member.
+1) Open the admin dashboard on your web page (default `127.0.0.1:8000/admin`), scroll down to the **Authentication and Authorization** section, and select `Users`.
+2) Create a new user by hitting `Add User` in the top right corner, enter a username and password for the user, and hit save.
+3) This will lead you to a more indepth user editing page where their name, email, and other such fields can be filled out. (**Note: If you want to invite your user to your team, they must have an email address entered**) Fill out the necessarily fields and hit save.
+4) After creating the user, proceed to the next section to add them to your team.
+
+## Inviting Users to Your Team
+After a user has been created, they cannot do much until they are apart of your team, currently there are two ways to accomplish this:
+1) **Adding Members in App**:
+    - Signed into the Sluggo iOS application, proceed to the admin tab and select the *Invite* row. Here you will be able to enter the email address of the created user which will notify them the next time they log in that there is an invite waiting for accepting.
+    - As the new user, once they log into the application with the same instance url, they will see no teams they can currently access. However, there will be a section on the Team Select view for *Invites* where they can accept or decline the invitation from you as a Sysadmin. 
+    - If they accept, it will add them to your team, and they may proceed to the rest of the application.
+2) **Adding Members through the Admin Dashboard**:
+    - If you choose against adding members in app, you may go and follow the same process outlined in ``Installing the API`` *Step 4*.
+    - Log into the admin dashboard, and select the `Members` field in the **API** section. Select create a member in top right and select the new user's `User Record` in the dropdown and the `Team` record corresponding to your team.
+    - Any optional fields such as role, pronouns, or bio can all be adjusted here before hitting save.
+    - The next time the user logs into the iOS application, they will see the team you created the record for in their Team select and proceed to the rest of the application.
+
+
+## Running the App
+1) When launching the app for the first time, fill in your user name and password for your sluggo instance.
+2) Your Sluggo instance is the url of the API, make sure to have the entire path listed for example: `http://127.0.0.1:8000/`
+3) You will be dropped in the team select page, where you may choose any team your account is apart of. Once you have picked one the homepage will appear. Feel free to poke around!