🚀 Next Level Week #02 - Mobile

Proffy is an online study platform that helps people find teachers online. This is the mobile version.

All the resources used by this application comes from its API.

📌 Table of Contents

• Screenshots
• Installation
• Getting Started
• Found a bug? Missing a specific feature?
• Contributing
• License

📷 Screenshots

Click to expand.

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/monteiro-alexandre/proffy-mobile.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:monteiro-alexandre/proffy-mobile.git

Install dependencies

yarn install

Or

npm install

Create your environment variables based on the examples of environment.example.ts

cp environment.example.ts environment.ts

After copying the examples, make sure to fill the variables with new values. to run locally you can fill the development environment. if you will use your cell phone for the test, make sure you have point your machine ip address in apiUrl and not use localhost

key	description	example
apiUrl	API's url	http://your_machine_ip_address:3333/

import Constants from 'expo-constants';

const ENV = {
	development: {
		apiUrl: 'http://your_machine_ip_address:3333/',
	},
	staging: {
		apiUrl: '',
	},
	production: {
		apiUrl: '',
	},
};

const getEnvVars = (env = Constants.manifest.releaseChannel): any => {
	let environment;
	// What is __DEV__ ?
	// This variable is set to true when react-native is running in Dev mode.
	// __DEV__ is true when run locally, but false when published.
	// eslint-disable-next-line
	if (__DEV__) {
		environment = ENV.development;
	} if (env === 'staging') {
		environment = ENV.staging;
	} if (env === 'production') {
		environment = ENV.production;
	}
	return environment;
};

export default getEnvVars;

🏃 Getting Started

Run the following command to start Expo DevTools:

yarn start

Than you can open the app in your cell phone using the Expo client app for IOS and Android, see:

Expo Documentation

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Proffy mobile repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

This project is licensed under the MIT License - see the LICENSE file for details.