Skip to content

StudyGrow/Cards

Repository files navigation

Cards Project

This project provides the code for frontend and backend of our cards website currently hosted on https://studygrow-cards.herokuapp.com/

Getting Started

To test this project locally you should clone this repository.

Prerequisites

To run this project you need to have the Node Package Manager installed, which can be downloaded here: https://www.npmjs.com/get-npm/

Additionally, following environment variables should be present:
PORT=
APP_AUTH_SECRET=
APP_AUTH_GOOGLE_CLIENTID=
APP_AUTH_GOOGLE_SECRET=
APP_AUTH_GOOGLE_REDIRECT_URI=
MONGO_URL_PRODUCTION=
MONGO_URL_TEST=
SECRET=
AUTH_TOKEN_EXPIRATION=
REFRESH_TOKEN_EXPIRATION=

Installing

Using the command line navigate to the projects folder and type in the following command:

npm install

npm will install all the dependencies for you. After that use the following command to start the server:

npm run watch

The server will tell you on which port it will be running in the console (80 by default). Navigate to http://localhost:port, where port is the port provdided by the server.

Modifiying the frontend

The frontend is built using Angular. The Angular project folder is located in angular-cards. Download and install Angular with:

npm install -g @angular/cli

Then navigate to the angular-cards folder and start the Angular Dev Server with the following command:

ng serve --proxy-config proxy.conf.json --open

We use proxy config to bypass CORS problem, caused by angular, when communicating with our server.
After you are done modifying the frontend you can use the following command to build your project:

ng build

After the process has finished you can stop the Angular Dev Server and navigate to http://localhost:port, where port is the port provdided by the server.

Built With

Authors

  • Erdzan Rastoder - Original idea, Initial work - Github
  • Ben Lakhoune - Initial work - Github - Website

License

This project is licensed under the MIT License

Acknowledgments

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •