SDA-Project

A repository maintained as a codebase for an application to be built for the course - Software Design Analysis at TCD.

How to setup and run the app ?

Code Repository Setup

• Clone this repo to your local machine (remember to switch to the main branch after cloning, if not set by default)
• Open the project in Android Studio.
• Allow all the background tasks to be completed. If not initiated, navigate to the gradle files and run gradle sync.
• Run the app on an Android Virtual Device / an android device connected via USB with developer options enabled.

APK

• Alternatively, navigate to the v2.0 release, and download the APK on your android device to run the app.

Contributing to SDA Project

Hello and welcome! We are so glad that you are interested in contributing to the SDA Project! We only have a couple of rules and we hope you enjoy the process :)

Contributing Rules

1. Don't move or delete any files. Only modify them.
2. Add all business logic files here.
3. Add all UI files here.

Contributing Process

1. Fork the repository
2. Clone your forked repository to your computer
3. Head to the issues tab and look for an issue that you like.
4. Once you have decided what issue to work on, give it a shot!
5. Once done, push the code to your forked repository.
6. Head to the Pull Requests tab and click on "Create New Pull Request"
7. On the left of the arrow should be this repo and on the right should be yours.
8. Add a small description to the Pull Request describing what you've done.
9. Mention what Issue you have worked on. If the issue number is #3, you can mention "Closes #3" in the Pull Request description.
10. Submit Pull Request

It's that easy! We hope you enjoy contributing to our repository. Don't hesitate to contact any of the maintainers about any problems!