Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Working with your own API

BuddiUp - Web Application

About

Please note that this project is still early in development.

BuddiUp is a platform that allows users to easily find others with similar interests and connect together. This platform provides a solution for the difficulty of forging interpersonal relationships in modern adult life. People are busier than ever and the need for productivity often outways the willingness to participate in the traditional activities necessary for making new friendships.

View the site live here.

Built With

• React
• Redux
• Redux Persist
• Axios
• Formik
• Yup
• Styled Components
• Antd for icons
• VantaJS
• Slick for React

Getting Started

These instructions will get you a copy of the project up and running on your local machine for testing purposes.

Prerequisites

If you haven't already, install NodeJS.

You should be able to run the following commands if you installed it properly:

node --version

npm --version

Installation

❗️Note that this application is only the front-end. There will be broken features if you do not have the back-end application which you can find here. You must run both in order to get the full experience.❗️

1. Clone the repository

git clone https://github.com/BuddiUp/web.git

2. Navigate into the correct directory

cd (CLONE DIRECTORY)

3. You now need to install all of the necessary packages for the project, type the following in your terminal:

npm install

4. In the project directory run:

npm start

Working with your own API

If you would like to implement your own custom API on your local machine follow these instructions to get started.

1. Navigate into the apis/ directory and locate buddiup.js

   1. Replace the baseURLwith the url to your API. Refer to the axios documentation to explore other configs if needed.

   export default axios.create({
      baseURL: 'YOUR_URL'
   });

2. Navigate into the store/actions/ directory and locate the actions.

   3. If you renamed the file in step 1 you will have to adjust the import name in the following files: action.auth.js action.discover.js action.profile.js

   4. Replace the routing in each request to your project's routes. The following example and code snippet can be found in store/actions/action.auth.js:

   buddiup
       .post('YOUR_ROUTE')
       .then((res) => {
       	  ...your stuff
           dispatch(authSuccess(res.data));
           history.push('/');
       })
       .catch((err) => {
           dispatch(authFail(err));
       });

3. Repeat step 2 where appropriate.