Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
:
  • Loading branch information
jmbarne3 committed Oct 3, 2017
1 parent 1e80be9 commit e31ee9b
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
# UCF-Announcements
Django application for managing and displaying UCF-Announcements.

## TODO
Write a readme!
## Installation and Setup

1. Install virtual environment: `pip install virtualenv`
2. Create virtual environment for your project: `virtualenv projectfolder` and move to the directory `cd projectfolder/`
3. Clone repository into src directory: `git clone [email protected]:UCF/unify-events.git src` and move to the directory `cd src/`
4. Activate virtual environment: `source ../bin/activate`
5. Install requirements: `pip install -r requirements.txt`
6. Install the required npm packages: `npm install`
7. Make sure the default artifacts are created: `gulp default`
8. Run the deployment steps: `python manage.py deploy`. This command is the equivelent of running the following individual commands:
a. `python manage.py migrate`
b. `python manage.py loaddata audience`
c. `python manage.py collectstatic -l`
9. Run the local server to debug and test: `python manage.py runserver`

## Changelog

### v1.0.1
Bug Fixes:
* Fixes [#10](https://github.com/UCF/UCF-Announcements-Django/issues/10) by implementing Main-Site-Theme v3.0.0 styles for navigation.
* Fixes [#11](https://github.com/UCF/UCF-Announcements-Django/issues/11) by updating col widths at various breakpoints and adding the `h-100` class to the columns.

Enhancements:
* Readded datetime pickers fixing [#12](https://github.com/UCF/UCF-Announcements-Django/issues/12)
* Added a slug and permalink field to the Announcements api
* Added basic filtering to the announcements endpoint.
* Added favicon
* Added support for a sitemap
* Added robots.txt
* Added snippets necessary for adding Google Tag Manager
* Updated automatic titles and meta descriptions
* Added delete view
* Added delete buttons to manager list

### v1.0.0
* Initial Release

0 comments on commit e31ee9b

Please sign in to comment.