Add push to heroku instructions in README

(Cornell University Events) Backend + Website v1.0

Backend: A system that supports APIs to access data about Events and Organizations etc. on Cornell's Ithaca campus.

Website: A web app for student organizations to add events for cue. Here is a list of related repositories:

Getting Started

You will need Python 3.6 to run the latest version of this app, which uses Django 2.0.1. Django can be installed using python's inbuilt pip function.

You will need IntelliJ IDEA v2018.2.5 to run the latest version of this app, which uses the following:

React.js v.16.4.2
Material-UI v.3.0.1.

Setup

Installing requirements

If typing python gives you version 3.x):

pip install -r requirements.txt

Otherwise:

pip3 install -r requirements.txt

Copy settings from dev-settings

Linux/Mac:

npm run copy-settings

Windows:

npm run copy-settings-windows

Make migrations

If typing python gives you version 3.x):

python manage.py makemigrations
python manage.py migrate

Otherwise:

python3 manage.py makemigrations
python3 manage.py migrate

Everyday

Before you run anything, do this right after git pull:

Run npm i in the project directory to install any additional front-end frameworks.
Run depending on platform:
- Linux/Mac, python 3 is default: npm run start
- Linux/Mac, python 2 is default: npm run start3
- Windows, python 3 is default: npm run start-windows
- Windows, python 2 is default: npm run start3-windows
This will copy dev_settings.py over to settings.py in events_backend, then start Webpack to hot-reload front-end changes as well as starting the Django server to hot-reload back-end changes. Isn't this an amazing script? (You can find it in package.json). Thank David later.

The front-end website will be located at 127.0.0.1:8000.

Code Review

After pushing any changes to the codebase, let's get your code reviewed. Some general guidelines:

Before you start changing any code, make sure you're synced with the master branch.
Create a new branch off master, and give it an informative name.
Commit your changes to this feature branch. Commit often so that you don't accidentally lose your progress!
Open a pull request (PR), give it a meaningful title and describe the changes that you made. Take note of any future improvements or any existing bugs with the changes you made. Give some steps as to how to test the changes you've made.
Notify others of the PR you created, and ask the relevant people to review it for you. They may leave comments and request changes, in which case you should make changes and push new commits to the same branch; the PR will update automatically!
Finally, when the change is approved by the reviewer, you can go ahead and merge the branch into the master branch.

Some things to watch out for when reviewing someone else's code:

Is the code documented? Are there comments that give details about what the code is doing?
Have commented-out lines of code been deleted?
Are your variable names clear, short, and meaningful?
Are your functions short and have a single purpose?
Are there redundancies in your code?

Database

If at any point, your database becomes corrupted or you no longer have db.sqlite3 in the directory:

Copy settings
Make migrations

Dependencies & Libraries

Django Rest Framework v. 3.8.2 - A Django library that provides powerful authentication protocols.
Django Simple History v. 2.0 - A Django library that provides methods to store changes to models, and thus, is used to create app-specific event, org. feeds.
react-avatar-editor - Similar to Facebook profile picture. Allows you to crop, resize, and rotate an uploaded image. Use for event image upload in event creation.

API Documentation

Backend API Documentation - An external Apiary documenting the endpoints for our application.

Contributors

2020

Jonna Chen - Front-End Developer
Woosang Kang - Back-End Developer
Mena Attia - Back-End Developer

2018

Arnav Ghosh - Back-End Developer
Jessica Zhao - Back-End Developer
Jill Wu - Back-End Developer
Adit Gupta - Back-End Developer
David Chu - Front-End Developer
Stacy Wei - Front-End Developer

We are a part of the O-Week/Events team within Cornell Design & Tech Initiative. For more information, see our website here.

Last updated 10/21/2018.

	"""
	class SignUpForm(UserCreationForm):
	name = forms.CharField(max_length=30, required=False, help_text='Optional.')
	netid = forms.CharField(max_length=30, required=False, help_text='Optional.')
	org_name = forms.CharField(max_length=30, required=False, help_text='Optional.')
	org_email = forms.EmailField(max_length=254, help_text='Required. Inform a valid email address.')
	facebook = forms.CharField(max_length=30, required=False, help_text='Optional.')
	website = forms.CharField(max_length=30, required=False, help_text='Optional.')
	contact_us = forms.CharField(max_length=30, required=False, help_text='Optional.')

	class Meta:
	model = User
	fields = ('org_name', 'password1', 'password2', 'name', 'netid', 'facebook', 'website', 'contact_us')
	"""

	# class Org(models.Model):
	# name = models.CharField(max_length=MAX_NAME_LENGTH)
	# description = models.CharField(max_length=MAX_DESC_LENGTH)
	# website = models.CharField(max_length=MAX_WEBSITE_LENGTH)
	# photo = models.ForeignKey(
	# 'Media', on_delete=models.CASCADE, blank=True, null=True)
	# contact = models.CharField(max_length=MAX_CONTACT_LENGTH)

	# verified = models.BooleanField(default=False)
	# history = HistoricalRecords()
	# owner = models.ForeignKey(
	# 'auth.User', related_name='org', on_delete=models.CASCADE) # user

	# def __str__(self):
	# return self.name

	# class Org_Media(models.Model):
	#
	# class Meta:
	# app_label = 'app'
	#
	# #org_id = models.ForeignKey('Org', on_delete=models.CASCADE, related_name = "org_media")
	# media_id = models.ForeignKey('Media',on_delete=models.CASCADE)

	# class Profile(models.Model):
	# org_name = models.CharField(max_length=30, blank=True)
	# name = models.CharField(max_length=30, blank=True)
	# netid = models.CharField(max_length=30, blank=True)
	# facebook = models.CharField(max_length=30, blank=True)
	# website = models.CharField(max_length=30, blank=True)
	# contact_us = models.BooleanField(default = False)
	# verified = models.BooleanField(default = False)

	#path('post/org/', views.OrgFormView.as_view(), name='post_org'),
	#path('post/org/<int:pk>/', views.post_detail_org, name='post_detail_org'),
	#path('post/org/<int:pk>/edit/', views.post_edit_org, name='post_edit_org'),

	#path('post/tag/', views.TagFormView.as_view(), name='post_tag'),
	#path('post/tag/<int:pk>/', views.post_detail_tag, name='post_detail_tag'),

	#path('post/event/', views.EventFormView.as_view(), name='post_event'),
	#path('post/event/<int:pk>/', views.post_detail_event, name='post_detail_event'),

	#path('post/location/', views.LocationFormView.as_view(), name='post_location'),
	#path('post/location/<int:pk>/', views.post_detail_location, name='post_detail_location'),

	#url(r'^email/orgEmail=(?P<org_email>.)&orgName=(?P<org_name>.)&name=(?P<name>[a-zA-Z\s]+)&netID=(?P<net_id>[a-zA-Z0-9]+)&link=(?P<link>.*)$', views.EmailDetail.as_view(), name='Email Detail'),

	# def post(self, request, format=None):
	# event = Event.objects.filter(pk=request.data["event"])[0]
	# user = Token.objects.filter(
	# pk=extractToken(request.META.get("HTTP_AUTHORIZATION"))
	# )[0].user
	# attendingSet = Attendance.objects.filter(user_id=user, event_id=event)

	# if not attendingSet.exists():
	# attendance = Attendance(user_id=user, event_id=event)
	# attendance.save()
	# event.num_attendees += 1
	# event.save()

	# return HttpResponse(status=status.HTTP_200_OK)
	# # TODO: if exists then response

	{/* <Typography variant={"h4"} className={classes.title}>
	Account Settings
	</Typography>
	<TextField
	label="Email Address"
	className={classes.textField}
	value={this.state.email}
	onChange={e => this.setState({ email: e.target.value })}
	margin={"normal"} />
	<Typography variant={"body1"} color={"inherit"}>
	Update your email address on your
	<LinkColorless to={routes.profile.route}> profile page </LinkColorless>

	//import VerifyCornellStatus from "./VerifyCornellStatus";
	//import VerifyOrg from "./VerifyOrg";
	//import VerifyDone from "./VerifyDone";

	//onboarding
	//describeTags: { route: "/app/describe", component: DescribeOrg }

	//verifyCornellStatus: { route: "/verifyCornellStatus/", component: VerifyCornellStatus },
	//verifyOrg: { route: "/verifyOrg", component: VerifyOrg },
	//verifyDone: { route: "/verifyDone", component: VerifyDone }

	// if (tags.length > 4) {
	// this.setState({ errors: ['Only can have up to 5 tags.'] })
	// console.log("HELLO")
	// return tags
	// }

cornell-dti / events-backend Goto Github PK

events-backend's Introduction

(Cornell University Events) Backend + Website v1.0

Contents

Getting Started

Setup

Installing requirements

Copy settings from dev-settings

Make migrations

Everyday

Code Review

Database

Dependencies & Libraries

API Documentation

Contributors

events-backend's People

Contributors

Stargazers

Watchers

Forkers

events-backend's Issues

Recommend Projects

Recommend Topics

Recommend Org