Giter Site home page Giter Site logo

ocean's Introduction

Ocean

A social media platform made to aid people suffering from mental health issues and to provide them with help through our features.

Prequisites on the local machine to project to be run:

  1. Python 3.6 or above
  2. Node JS v12.0.0 or above
  3. Yarn 1.22.4
  4. Expo SDK 38
  5. pip 3 v20.0.x or above

Steps to run the project on the local machine

  1. Clone this repository into your local machine by using
    git clone https://github.com/tanmaypardeshi/Ocean.git
  • Setting up the django and flask development server:

  1. Install virtualenv using pip3 install virtualenv
  2. Create a new virtualenv using virtualenv venv
  3. Activate virtualenv using source venv/bin/activate
  4. Install all required dependencies using pip install -r requirements.txt
  5. cd into the backend directory and run the migrations using makemigrations and migrate. Navigate to settings.py and add your email and password to use the mailer facility.
  6. To run the django development server python manage.py runserver.
  7. Deactivate the virtualenv using deactivate.
  8. To run the flask server, cd into coral and enter the necessary details in coral_config.json.
  9. Run python run.py.

Note: Step 1,2,4,5 and 8 are one time process to set up data and dependencies.

  • Setting up the react local server:

  1. cd into the frontend directory.
  2. Use command yarn to install node modules for the front end.
  3. Keep the django server up and running to make the website functional.
  4. Once the node modules have been installed, run yarn start to start the development server.
  • Setting up expo SDK for the mobile app:

  1. cd into the mobile directory.
  2. Use command yarn to install node modules for the mobile app.
  3. Keep the django server up and running on your local network to make the app functional. Note that the command for the django server in this case will be python manage.py runserver :8000
  4. Once the node modules have been installed, run yarn start to start the expo server.
  5. Scan the QR code on your mobile device using the expo app available on play store.

ocean's People

Contributors

tanmaypardeshi avatar kausko avatar

Stargazers

Aboli Marathe avatar Pranjal Newalkar avatar  avatar

Watchers

James Cloos avatar  avatar

Forkers

kausko

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.