INDA-Projekt

Fix da DMK hemsida -> dkm.io

• INDA-Projekt
  • START
    • Webapp
    • DB
    • Webscraper
  • Repo structure
    • dkm
    • server
    • aws
    • fb-webscraper
  • Project Specification
    • Links
      • Dependencies
    • Naming conventions
      • Issues and Commits
      • PRs
    • Project Description
    • MVP Requirements
    • Who does what?

START

Webapp

To host the webpage locally for the first time just run the following commands in order:

1. cd dkm
2. npm install
3. npm run start

Once the inital setup is done you just need to run the third command to boot up the localhost.

DB

• Create a .env file
• Add parameter, eg: POSTGRES_CONNECTION=postgres://dkm:dkm@localhost:5432/dkm
• Change the values in the database.sh file
• Start the database by runnning database.sh
• You may need to add sudo permissions etc to the .sh file

ALternative - docker-compose

• start the docker-compose file with docker-compose up
• No need for .env

Webscraper

To run the webscraper first make sure to have a aws credentials file with the infom profile. It should look something along the lines of:

[infom]
aws_access_key_id = YOUR_ACCESS_KEY
aws_secret_access_key = YOUR_SECRET_ACCESS_KEY

Then just run node ./fb-webscraper/scrape.js from the repo.

Repo structure

The repository is grouped into four larger subfolders.

dkm

Contains the whole react app (frontend of the application). Most noteble files are within the /src subfolder, which contains the source code.
/components house all the reoccuringly used components. Such as a carousel for displaying events or the visual loader that is shown before data has been fetched.
/pages as the name suggests contain each frontend page. The only two currently in use are events and about. Though you might still be able to visit some of the others ;^)
/style contains the styling files for the larger webpages that share some styling. Components styling is located in the aforementioned /components folder.

server

aws

This subfolder contians some of the aws functions source codes.

fb-webscraper

The server folder only contains one final script (it's been a mess). scrape.js scrapes DKMs upcoming events page and pushes these to the aws http endpoint. The reason this is currently not hosted at our own server is because the infrastructure for aws already existed so we simply had to create the lamda, api and dynamodb backend for it. It's also quite useful since we can use s3 for image storage and not have to worry about that.

Project Specification

Links

• Trello
• Canva

Dependencies

• Goquery

Naming conventions

Issues and Commits

Each commit should preferabbly have a connected issue to help us keep track. Feature branches can also be used as an alternative.
Project-week-0: Gotta use the issue tracker. "For every feature you want to create (or bug to fix), there should be an associated issue"

PRs

When merging a branch the main feature or purpose should stand as the PR title nad use the following keywords. The PR description should include a list of all changes.

• [Feature]: Used when implementing a new feature. A short description and example usecase should preferably be included.
• [Quickfix]: A simpler fix for a issue that hasn't had time to become a github issue yet.
• [Refactor]: Reworking an old feature or infrastucture.
• [Fix #[number]]: A fix associated with a github issue.

Project Description

(Include short part about how feasible your project is and how it can be divided into weeks) This project aims to create a new website for the student club DKM.
The project should include a new landing page, event page and about page. We also want to set up a reliable back-end for the webpage to handle storing and fetching events. Hopefully we also have time to reach some of our streatch goals like including the drinks menu.

MVP Requirements

See Canva project above. The parts of the map colored cerise is the MVP of this project.

Who does what?

We have chosen to divide the project between us using trello. Since we are only two developers we don't see a need to decide all aspects of dividing the work right from the start. Instead all tasks are written in trello and we just asign ourselves to whatever we are currently working on or planning.