Giter VIP home page Giter VIP logo

berkeley-coop's Introduction

Development

The application requires two servers to run at the same time.

Starting the client (Web Interface)

Ensure you have a suitable version of node and npm and ensure you are inside the client directory.

cd ./client

npm install

npm run dev

Now view the console for the port that the development server is listening on. It should be localhost:3000

Starting the server (Backend interface)

You MUST have the following Elixir dependencies installed. You can install both from elixir-lang website. Install the following versions:

Elixir 1.15.4
Erlang/OTP 26 [erts-14.0.2]
PostgreSQL 15

After successfully installing, you should be able to see the version in the terminal

elixir -v

Erlang/OTP 26 [erts-14.0.2] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit] [dtrace]

Elixir 1.15.4 (compiled with Erlang/OTP 26)

Additionally, you must have a postgreSQL server installed. See instructions here. Once Elixir, OTP 26, and PostreSQL are installed, you can run the following commands sequentally. First ensure you are in the server directory:

cd ./server
mix deps.get
mix deps.compile
mix ecto.reset
mix phx.server

The server while now be available on localhost:4000. The frontend client is already programmed to communciate with the server on port 4000. No additional configuration is needed.

Accessing the app locally

Navigate to localhost:3000 and you will be confronted with the sign in page. The local database comes seeded with the following login automatically:

username: [email protected]
password: Password123

This will give you full access to the application and functionality.

berkeley-coop's People

Contributors

jdyn avatar

Watchers

Patrick avatar Alexander Lin avatar  avatar

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.