maria / cub Goto Github PK

• Contribution Base Class
• CommitContribution - https://developer.github.com/v3/repos/commits/#get-a-single-commit
• Pull RequestContribution - https://developer.github.com/v3/pulls/#get-a-single-pull-request
• Score

Integrate Tastypie - instead of Django Rest Framewor.

Need

We need an attribute for the repo object that tells us if the repo is a fork or not and the description of the repo. We may also need to save the link to the original (we should discuss this).

Need

Sync deleted github repos with our list.

Need

We need to have some user stats on his/her profile page.

Deliverables

Add the following attributes to /api/v1/myaccount/ response:

• watchers - total number of watchers on all public repos (owned or collaborative ones)
• stars - total number of stars on all public repos (owned or collaborative ones)
• pulls - total number of pull requests on all public repos (owned or collaborative ones)

Update own profile endpoint.
Update another user's profile stats endpoint.

Need

Now we use Django with PostgreSQL and MongoDB, a hybrid which is hard to maintain and doesn't have much sense. Since the Django won't officially support Mongo in the upcoming releases and Flask is easier to implement with Mongo I suggest we move now, while we still can.

Solution

• Create a new directory called api
• Define a new file called app.py where our main Flask application will be defined
• Define MongoDB as the database
• Add a config file like settings.py
• Define the api as http://flask-restful-cn.readthedocs.io/en/0.3.5/
• Define api classes for each resourse
• Define routes for logging in user, logging out and api
• Remove django

Need

Have some bonus points for different git goodpractices, like:

• no passwords found in any repos
• all repos have descriptions
• etc
  We can also use this for the 'teaching' side of the project.

Need

When a new (unauthenticated) user accesses the site, he should see some (not all) info about other users.

Deliverables

Provide new endpoints:

• for profile: show name, username, avatar
• for repos: show list of repos, but no score

Need

Keep track of open and closed issues per repository.

Deliverables

Have open_issues and closed_issues attributes for the repo object.

Need

We need to include repositories where the user is a contributor for, because they are important for the score.

Deliverables

Display collaborative repos in the repos list.

Need

When someone is signed in update the profile URL to be https://connecthub.herokuapp.com/profile/username

Need

Add ability to view another user's profile.

Deliverables

GET /api/v1/account/USER/?format=json
where USER is a GitHub username

Notes

We must include:

• 404 page for users that have never logged in

Need

Have a method to receive feedback from users.

Deliverables

Have a contact form in the Contact page.
Enable an POST /api/v1/contact endpoint, which send an email to us, containing the feedback from the contact form.

When you submit a post request to one of the contribution endpoints,
update the data.

• Score
• Pulls
• Commits
• Repos