| Tommy Coleman | May Ng | Kevin Tou | Justine Lai | Ya'Kauna Davis | Richard Lawson |
|---|---|---|---|---|---|
 |
 |
 |
|||
 |
|
|
|
|
|
An alternative networking platform that we hope to bridge the gap of social media isolation.
A social platform connecting individuals to the World around them.
- Sign Up
- Login
- Creating Activities
- Editing Activities
- Deleting Activities
- Dashboard
- Joining Activities
- Profile
Front-end Overview
-
React Native Form Validator - Used to validate form fields
-
React Native Gesture Handler - Provides native-driver gesture management APIs for building the best possible touch-based experiences
-
React Native Keyboard Aware Scroll View - Drop-in replacement for RN Scrollview which handles the ScrollView insets properly when the keyboard is shown or hides
-
React Native Loading Spinner Overlay - Loading spinner overlay
-
React Native Reanimated - React Native's Animated library reimplemented. Allows for greater flexibility with gesture based interactions
-
React Native Navigation - Complete native navigation solution for React Native
-
React Native Navigation Stack - Provides a way for the app to transition between screens, placing new screen on top of the stack
-
React Redux - Lets React components read data from a Redux store and dispatch actions to the store to update data
--- Under development ---
Back-end Overview
-
express - Web framework for Node
-
cors - Express middleware used to enable CORS (Cross-origin resource sharing)
-
bcrypt - Helps hash passwords
-
knex.js - SQL query builder
-
knex-cleaner - Helper library to clean databases using Knex
In order for the app to function correctly, the user must set up their own environment variables.
There should be an app.json file containing the following:
`iOSKey` - this is your iOS Key for Segment (used for analytics with Mixpanel)
`AndroidKey` - this is your android Key for Segment (used for analytics with Mixpanel)
For testing, we used Jest and react-native-testing-library.
Jest was chosen for it's wide variety of testing tools and the fact that it came alog with Expo.
react-native-testing-library was chosen for its compatibility with React Native.
Step 1: Clone Repo
Step 2: Install node modules
npm install
Step 3: If using Android
npm start
Then press a to run for android
Before run android build, install and setup Android Studio
Step 4: If using iOS
npm start
Then press i to run for iOS
Before running iOS build, install Xcode
**NOTE** - npm start is the same as running expo start
* start - starts the production server after a build is created
* test - runs tests
* eject - copy the configuration files and dependencies into the project so you have full control over them
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.