Giter VIP home page Giter VIP logo

backend's Introduction

Alexandria is an open source language learning app that allows users learn languages using text.

Read about how we made it here.

Alexandria is accessible here.

Running Alexandria locally for development

  1. Follow the instructions here [https://docs.docker.com/get-docker/] to install Docker Desktop
  2. Clone this repo and the frontend
  3. Run npm install to install the dependencies
  4. Add a .env file to the root directory with the values from src/model/.env.sample
  5. Run npm run start-docker-postgres
  6. Run npm run dev
  7. Follow the getting started instructions in the frontend README.md

Testing

To run the tests, run npm run pgtest. This command spins up a docker container with a fresh postgres database for the tests, runs the tests, and then shuts down the container. Just running npm test will cause the tests to fail if the docker container is not available.

Troubleshooting

If, when getting the backend and frontend working together, you get a 500 error from the languages endpoint, make sure that the database is running locally and that the seed data is present. You can start the database by running npm run start-docker-postgres.

backend's People

Contributors

danachen avatar eamon0989 avatar medic-code avatar mrchrmn avatar

Watchers

 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.