Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

react-epfl/graasp-app-starter-angular

Repository files navigation

Graasp App Starter: Angular Framework

This is a starter repository for a Graasp application. This particular flavor of the starter repository uses the Angular framework. It is an opinionated starter kit generated with Angular CLI version 6.1.5.

Getting Started

Fork this repo.

Request Credentials

Currently, becoming a Graasp Developer and registering Graasp Apps is a manual process. Contact [email protected] or [email protected] to receive a GRAASP_DEVELOPER_ID. Every time you want to release a new app, you will also have to request a GRAASP_APP_ID. This process is being automated, but it's currently still in the works.

We will also give you AWS credentials, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, which you will need to deploy your application to the Graasp ecosystem. These keys are private, so you should not share them with anyone.

Environment Variables

Create a file in your project root named .env and add the following lines, replacing the values between <> with the keys you received.

GRAASP_DEVELOPER_ID=<YOUR_GRAASP_DEVELOPER_ID>
GRAASP_APP_ID=<YOUR_GRAASP_APP_ID>
AWS_ACCESS_KEY_ID=<YOUR_AWS_ACCESS_KEY_ID>
AWS_SECRET_ACCESS_KEY=<YOUR_AWS_SECRET_ACCESS_KEY>

Setup Development Environment

Once you have set up your .env file, you need to run ./scripts/setup.sh from the root folder in order to setup your credentials. This script will write the appropriate credentials to a ~/.aws/credentials file that will allow you to deploy your application to the ecosystem.

Installing Dependencies

Make sure you have node and yarn installed on your local machine otherwise go here and install them; then run yarn or npm install from the project directory to install all dependencies.

Starting the Server

Navigate to the cloned or forked project directory using the command line, type npm start and the project will automatically run on localhost:4200.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published