An application that lets you find and match with like-minded students on campus to study, have a meal with, and more!
- To start, clone the repository:
git clone https://github.com/ufosc/Lunch_Buddies.git - Navigate to the project directory
cd Lunch_Buddies - If you haven't already, install Node.js (version 16.18.0) through this link: Download Node.js
- To check if you have successfully installed Node.js, you should see the current version of Node.js installed on your computer if you type this into the terminal:
node --versionornpm --version
- To check if you have successfully installed Node.js, you should see the current version of Node.js installed on your computer if you type this into the terminal:
- You will also need to install Golang, which is what we are using for the API. You can do through this link: Download Golang
- The back-end uses a MySQL database, so you will need to install MySQL on your local machine and create a user. The instructions in the Usage section will explain what you need to do with your MySQL login.
- After installing MySQL, enter your database and coppy the full code from
api/database.sqland paste it in. This will ensure that your MySQL installation contains the same database and table schema as everyone else. - Once this is finished, start VS Code and open the "Lunch_Buddies" file. Open the terminal within VS Code and
cd Lunch_Buddies. - After this, enter the client directory with the command
cd clientand typenpm installto download the required packages for the front-end.- If you havent already dowloaded Expo CLI, type this into the terminal:
npm i expo-cli
- If you havent already dowloaded Expo CLI, type this into the terminal:
- Then, enter the api directory with the command
cd ../apiand run the commandgo getto download the go packages that are needed.`
-
Before running the application, copy the
.env.examplefile into a file called.envand fill in the corresponding credentials. -
To run the front-end, use the command
npm run startin the client folder. -
To run the server, enter the api folder and run
go build, and then run the executable that is created. -
Download the "Expo Go" app in order to emulate the current version of your app.
- You need to create an Expo account
- NOTE: Make sure your dev machine(desktop, laptop, etc.) and your smartphone are on the same wi-fi network
- After running
npm run startin the client folder, a QR code should be generated - For iOS: scan QR code with iPhone camera
- For Android: use the Expo Go app to scan the QR code
- Expo provides tools to debug the app
- Error messages are displayed on your phone, any speccific errors can be searched online or discussed with tech leads
- Shaking the device will open the developer menu, which allows you to refresh the app
- Remote JS debugging is available in a browser, and the element inspector will list the characteristics of a given component.
- All contributions are welcome and appreciated!!
- Programming Languages: JavaScript, Go
- UI software framework: React Native
- The React Native documentation has the most useful information for beginners
- Some components (ex. sliders) can lead to crashes on Android. It's strongly encouraged to test on both operating systems, if possible
- A Figma file is available here (https://www.figma.com/file/XakFXYjXOjFdD0Gljp51Rj/draft-(Copy)?node-id=0%3A1)
- These screens are a helpful guide, but won't neccesarily reflect the final product.
- You can use these links to get familiar with programming languages/frameworks/libraries we will be using: