Oauth login flow

Getting Started

Prerequisites:

Usage:

Step 1:

Included is an automation script ./start that composes the website's development environment using Docker

Once Docker has been installed, From the root directory:

git clone https://github.com/heyitsmass/BayView && cd BayView && touch.env

⛔ If you EVER need to access environment variables while programming, only use the environment variables process.env.DISCORD_API_TOKEN and process.env.DISCORD_CLIENT_ID. DO NOT copy and paste them outside of the .env file.

Step 2:

chmod +x start && ./start

📍 This will create a .built file with the build date/time stamped into it, Subsequent calls to ./start will only initialize a new container from the previous image. To update dependencies, pass the -b|--build option to rebuild the image or -h|--help to display the help menu

Your output should be similar to:

[+] Building 1.8s (18/18) FINISHED														
...
[+] Running 1/1
✔ Container bayview-development  Created                                                      		
Attaching to bayview-development
bayview-development  |
bayview-development  | > [email protected] dev
bayview-development  | > next dev
bayview-development  |
bayview-development  | ✓ Compiled /instrumentation in 177ms (48 modules)
bayview-development  | ▲ Next.js 13.X.X
bayview-development  | - Local:        http://localhost:3000
bayview-development  | - Environments: .env
bayview-development  | - Experiments (use at your own risk):
bayview-development  |    · esmExternals
bayview-development  |    · serverActions
bayview-development  |    · instrumentationHook
bayview-development  | 
bayview-development  | ✓ Ready in 2.2s

Step 4:

Open http://localhost:3000 with your browser to see the result, you should be redirected to the /home page indicating proper initialization.

⚠️For best results use FireFox Developer Edition with the React DevTools addon.

Additional Notes:

FastRefresh is enabled for the development environment, As long as the server is running then any changes made to files within the original source directory will force the server to recompile. This allows you to quickly and seamlessly update the website during development and see those updates in real-time without have to rebuild the entire Docker container. Check the docker-compose.yml file for more information.

The only changes that will require a restart are made to or 'package.json' while updating dependencies or to the instrumentation.ts file which runs when a new server instance is bootstrapped.

This initializes database connections and performs any work that's necessary throughout the lifetime of the website but only needs to occur once.

Design Expectations

It is expected these design patterns will be followed upon contributing to the repo, These patterns are intended to make portability, extension and expansion of BayView simple and legible.

⚠️ Context is essential! If you have to pass data or functions deeply within multiple components or across routes then wrap your component in a Context, create a reducer, develop it's actions, assign the state values and export the context for use across multiple modules.

⚠️Avoid excessively using useEffect. You might not need it

Issues:

📍If the server hangs during shutdown attempting to close it with ctrl+c then you can either stop it directly from Docker Desktop or open a secondary console window and type docker kill bayview-development

📍While potentially unrelated, if you get a dial unix /var/run/docker.sock: connect: permission denied error then type chmod 666 /var/run/docker.sock and retry

Disclaimers:

Non-Affiliation

This web site and internet bot is not endorsed by, directly affiliated with, maintained, authorized, or sponsored by Disney or its subsidaries. All product and company names are the registered trademarks of their original owners. The use of any trade name or trademark is for identification and reference purposes only and does not imply any association with the trademark holder of their product brand.

Fair Use

This website utilizes product images from other websites including but not limited to logos, images, or other content publicly provided by manufacturers, advertises and businesses. In doing so, no copyright is claimed for this kind of content on the website. To the extent that such material may appear to be infringed, we assert that such alleged infringement is permissible under the fair use principles of U.S. copyright laws. If you believe any material has been used in an unauthorized manner, please contact us at: [email protected] for immediate removal of any copyrighted material.

Disney

A request has been made to acquire licensing permission for intellectual property of Baymax. Please have a representative of Disney Enterprises or their Legal Team respond to the inquiry for immediate removal of the imagery, any notice for DMCA should be sent to [email protected] if any intellectual property rights have been violated before a response has been generated.

	class DiscordNotifier implements Notifier {
	/** Discord Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users discord account */
	}
	}

	private get_storage() {
	/** Gets the current storage method */
	}

	private set_storage(storage: StorageMethod) {
	/** Sets the current storage method */
	}

	interface Person {
	/** Generic person representation. */
	name: {
	first: string;
	last: string;
	middle?: string;
	username?: string;
	}
	email: string;
	phone: string;
	discord: {
	username: string;
	id: number \| string;
	}
	/** Gets the name as a string */
	get_name: () => string;
	add_notifier: (notifier: Notifier) => void;

	}

	class ItineraryFlow {
	private identity: IdentityState = 'anonymous';
	private stage: FlowState = 'uninitialized';
	private storage: StorageMethod = 'local';
	private state: State = new LoginFlow();

	private user: {
	authorization: string;
	username: string;
	} \| null = null;

	private get_next_state() {
	/** Gets the next flow state */
	}

	private get_previous_state() {
	/** Gets the previous flow state */
	}

	private visit_state(state: State) {
	/** Visits the state */
	}

	public get_state() {
	/** Gets the current state */
	}

	public set_state(state: State) {
	/** Sets the current state */
	return this.visit_state(state);
	}

	private get_identity() {
	/** Gets the current identity */
	}

	private set_identity(identity: IdentityState, user?: { authorization: string; username: string; }) {
	/** Sets the current identity */
	}

	private get_storage() {
	/** Gets the current storage method */
	}

	private set_storage(storage: StorageMethod) {
	/** Sets the current storage method */
	}

	}

	export class Activity extends Event implements IEvent {
	/** Activity class for the Events */

	public get_url() {
	/** Returns the reservation link for the activity */
	return '';
	}
	}

	class FacebookNotifier implements Notifier {
	/** Facebook Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users facebook account */
	}
	}

	class SlackNotifier implements Notifier {
	/** Slack Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users slack account */
	}
	}

	public get_current_event() {
	/** Returns the currently active event */
	}

	public get_next_event() {
	/** Returns the next event */
	}

	public get_previous_event() {
	/** Returns the previous event */
	}


	public get_events() {
	/** Returns the events in the group */
	}

	export class Ticket extends Event implements IEvent {
	/** Ticket class for the Events */

	public get_url() {
	/** Returns the purchase link for the ticket */
	return '';
	}
	}

	export class Lyft implements Transportation {
	/** Lyft class for the Events */

	public get_url() {
	/** Returns the reservation link for the lyft */
	return '';
	}
	}

	export class Restaurant extends Event implements IEvent {
	/** Restaurant class for the Events */

	public get_url() {
	/** Returns the reservation link for the restaurant */
	return '';
	}
	}

	class EmailNotifier implements Notifier {
	/** Email Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users email */
	}
	}

	public get_location() {
	/** Retusn the location of the current event */
	}

	class TwitterNotifier implements Notifier {
	/** Twitter Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users twitter account */
	}
	}

	class SMSNotifier implements Notifier {
	/** SMS Notifier implementation */
	public send_notification() {
	/** Sends a notification to the users phone */
	}
	}

	public createItinerary() {
	}

	public get_transportation() {
	/*Returns the transportation attatched to the event /
	}
	public get_transportation_url() {
	/*Returns the current transportation urls attached to the evet /
	}

	abstract class ItineraryManager {

	public static itineraries: Itinerary[];
	public flow = new ItineraryFlow();

	public loadItineraries() {
	/** Fetches the itineraries from the database. */
	};
	public saveItineraries() {
	/** Flushes the database with the current list of itineraries */
	};

	public addItinerary(itinerary: Itinerary) {
	/** Adds an itinerary to the database */
	}

	public removeItinerary(itinerary: Itinerary) {
	/** Removes an itinerary from the current storage method */
	}

	public modifyItinerary(itinerary: Itinerary) {
	}

	public getItineraries() {
	/** Returns the current list of itineraries */
	}

	public getItinerary(itinerary: Itinerary) {
	/** Locates the itinerary in the cache*/
	}

	public createItinerary() {
	}

	public initializeFlow() {
	this.flow.set_state({ type: 'login' });
	return this.flow.get_state(); //login
	}

	public add_event(event: Event) {
	/** Adds an event to the group */
	}

	public remove_event(event: Event) {
	/** Removes an event from the group */
	}

	public modify_event(event: Event) {
	/** Modifies an event in the group */
	}

	export class Flight extends Event implements IEvent {
	/** Flight class for the Events */

	public get_url() {
	/** Returns the reservation link for the flight */
	return '';
	}
	}

	export class Group extends EventManager {

	public get_current_event() {
	/** Returns the currently active event */
	}

	public get_next_event() {
	/** Returns the next event */
	}

	public get_previous_event() {
	/** Returns the previous event */
	}


	public get_events() {
	/** Returns the events in the group */
	}

	public add_event(event: Event) {
	/** Adds an event to the group */
	}

	public remove_event(event: Event) {
	/** Removes an event from the group */
	}

	public modify_event(event: Event) {
	/** Modifies an event in the group */
	}

	public get_start_time() {
	/** Returns the start time of the current event */
	}

	public get_end_time() {
	/** Returns the end time of the current event */
	}

	public get_location() {
	/** Retusn the location of the current event */
	}

	public get_transportation() {
	/*Returns the transportation attatched to the event /
	}
	public get_transportation_url() {
	/*Returns the current transportation urls attached to the evet /
	}

	}

	export class EventManager {
	/** Context manager functions */
	private event!: Event; //state
	private events!: Event[]; //current events in the manager
	private $history!: Event[]; //history of events in the manager
	private transition_to_next_event() {
	/** Transitions current state to the next event */
	const state = this.events.pop();
	if (!state)
	return;
	this.$history.push(this.event);
	return this.event = state;
	}

	private switch_to_event(event: Event) {
	/** Switches the current event to the specified event */
	this.$history.push(this.event);
	return this.event = event;
	}

	private transition_to_previous_event() {
	/** Transitions current state to the previous event */
	const state = this.$history.pop();
	if (!state)
	return;
	return this.event = state;
	}
	}

	export class Pass extends Event implements IEvent {
	/** Pass class for the Events */

	public get_url() {
	/** Returns the purchase link for the park pass */
	return '';
	}
	}

	export class CoordinatedItinerary extends Itinerary {

	public get_coordinators() {
	/** Returns the coordinators in the itinerary */
	}

	public add_coordinator() {
	/** Adds a coordinator to the itinerary */

	}

	public get_groups() {
	/** Returns the groups in the itinerary */
	}

	public add_group(group: Group) {
	/** Adds a group to the itinerary */
	}

	public remove_group(group: Group) {
	/** Removes a group from the itinerary */
	}

	public modify_group(group: Group) {
	/** Modifies a group in the itinerary */
	}

	}

	export class Hotel extends Event implements IEvent {

	/** Hotel class for the Events */

	public get_url() {
	/** Returns the reservation link for the hotel */
	return '';
	}
	}

heyitsmass / bayview Goto Github PK

bayview's Introduction

Getting Started

Prerequisites:

Usage:

Step 1:

Step 2:

Step 4:

Additional Notes:

Design Expectations

Issues:

Disclaimers:

Non-Affiliation

Fair Use

Disney

For any additional inquiries please reach out at [email protected]

bayview's People

Contributors

Stargazers

Watchers

Forkers

bayview's Issues

Flight Search Component Implementation

Description

Open Questions

Tasks

Recommend Projects

Recommend Topics

Recommend Org