Skip to content

Commit

Permalink
Merge pull request #28 from SheCodesAus/dev
Browse files Browse the repository at this point in the history
BkD README file updated
  • Loading branch information
lruizper committed Apr 11, 2024
2 parents 9c6fce8 + f196610 commit 1148692
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# Group Project Back End: Gift Compare website
By First Class Constructors Team - March 2024


This repo contains the `.gitignore` and `requirements.txt` you'll need to get started on your back end. A django project hasn't been created yet, so one person from the group will need to:

- clone the repo down
- create+activate a venv
- perform a `pip install` to install the modules listed in the `requirements.txt` file
- run `django-admin startproject YOUR_PROJECT_NAME_HERE` to launch a django project
- make a commit
- push to main

Then everyone else in the group can clone the repo down and get cracking! Have a look at the "Project Setup" notes from Thinkific if you need a refresher on how to get started creating the apps you need, and feel free to reach out to mentors for help!

Don't forget to use good Git technique and co-ordinate with each other to avoid merge conflicts!

### Links:
### Live backend: [Gift Compare_backend](https://giftcompare-backend.fly.dev)
### Live website: [GiftCompare](https://giftcompare.netlify.app/)
### Frontend Github Repo: [FrontendRepo](https://github.com/SheCodesAus/2024_first_class_constructors_front_end)


## Concept/Name:
Expand All @@ -29,6 +19,8 @@ Whether you're a seasoned gift-giver or dread having to select one, Gift Compare
## Planning:
This project used:
* Django Rest framework to build the backbone of the website/APIs.
* drawsql.app: DB design
* SQLite3 as database
* Insomnia to show the APIs/Endpoints functionalities
* Fly.io to deploy the backend live version

Expand All @@ -53,7 +45,7 @@ This project used:


## Features:
- Users can signup but at this stage of the MVP having an account is not required by the Client;
- Users can signup, login and see their details on the Profile page but, at this stage of the MVP do not interact with the rest of the website as requested by the Client;
- Necessary APIs use Token Authentication for appropriate user authentication and authorization;
- APIs returns the relevant status codes for both successful and unsuccessful requests to APIs;
- The handling of graceful failed requests will be part of frontend development;
Expand Down
3 changes: 0 additions & 3 deletions giftcompare/giftcompare/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
from django.contrib import admin
from django.urls import path, include
import gifts.views as views
from users.views import UserRegistrationView
from rest_framework.authtoken.views import obtain_auth_token
from .views import CustomAuthToken

urlpatterns = [
Expand All @@ -27,7 +25,6 @@
path('', include('categories.urls')),
path('', include('users.urls')),
path('api-auth/', include('rest_framework.urls')),
path('users/register/', UserRegistrationView.as_view(), name='user-register'),
path('api-token-auth/', CustomAuthToken.as_view(), name='api_token_auth'),

]

0 comments on commit 1148692

Please sign in to comment.