carolyz / se-challenge-expenses

Django implementation of code challenge

Wave Software Development Challenge by Carol Zhang

Getting Started

This project is done in Django. Make sure Django is installed and up-to-date by running

$ python -m django --version

Assuming Django is installed, cd into the project directory and run

$ python manage.py runserver

Go to http://localhost:8000/expenses/ in the browser, and you should see the file upload form.

Original Project Description

Imagine that Wave has just acquired a new company. Unfortunately, the company has never stored their data in a database, and instead uses a comma separated text file. We need to create a way for the new subsidiary to import their data into a database. Your task is to create a web interface that accepts file uploads, and then stores them in a relational database.

What your web-based application must do:

1. Your app must accept (via a form) a comma separated file with the following columns: date, category, employee name, employee address, expense description, pre-tax amount, tax name, and tax amount.
2. You can make the following assumptions:
3. Columns will always be in that order.
4. There will always be data in each column.
5. There will always be a header line.

An example input file named data_example.csv is included in this repo.

1. Your app must parse the given file, and store the information in a relational database.
2. After upload, your application should display a table of the total expenses amount per-month represented by the uploaded file.

Your application should be easy to set up, and should run on either Linux or Mac OS X. It should not require any non open-source software.

There are many ways that this application could be built; we ask that you build it in a way that showcases one of your strengths. If you you enjoy front-end development, do something interesting with the interface. If you like object-oriented design, feel free to dive deeper into the domain model of this problem. We're happy to tweak the requirements slightly if it helps you show off one of your strengths.

Documentation:

Please modify README.md to add:

1. Instructions on how to build/run your application
2. A paragraph or two about what you are particularly proud of in your implementation, and why.

Submission Instructions

1. Fork this project on github. You will need to create an account if you don't already have one.
2. Complete the project as described below within your fork.
3. Push all of your changes to your fork on github and submit a pull request.
4. You should also email [e-mail] and your recruiter to let them know you have submitted a solution. Make sure to include your github username in your email (so we can match applicants with pull requests.)

Alternate Submission Instructions (if you don't want to publicize completing the challenge)

1. Clone the repository.
2. Complete your project as described below within your local repository.
3. Email a patch file to [e-mail]

Evaluation

Evaluation of your submission will be based on the following criteria.

1. Did you follow the instructions for submission?
2. Did you document your build/deploy instructions and your explanation of what you did well?
3. Were models/entities and other components easily identifiable to the reviewer?
4. What design decisions did you make when designing your models/entities? Why (i.e. were they explained?)
5. Did you separate any concerns in your application? Why or why not?
6. Does your solution use appropriate datatypes for the problem as described?