-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from fac19/write-tests
add readme
- Loading branch information
Showing
3 changed files
with
85 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,85 @@ | ||
# week4-harl | ||
# week4-harl | ||
|
||
## Description | ||
|
||
Harl is a microblogging site for vikings to connect with one another. Not to be confused with Twitter. | ||
|
||
## Install the dependencies | ||
|
||
After downloading the repo run `npm install` in your termninal and that would install all the necessary dependencies for you. | ||
|
||
|
||
___ | ||
|
||
## How to run tests | ||
To run the rests, type `node run test` in your terminal. | ||
|
||
___ | ||
|
||
## How to run development server | ||
To run dev server on your local machine you can type `npm run start:dev` that wil start nodemon server(not to be confused with pokemon or demon or many other things). | ||
|
||
____ | ||
|
||
|
||
## Prototyping | ||
In terms of prototyping the project, we focused primarily on setting up the server and then went for a simplistic style, similar to the one we used in our To Do list which can be viewed [here](https://https://fac19.github.io/week3-harl/) | ||
___ | ||
## User stories | ||
### As an opinionated Viking you can: | ||
* post your thoughts so fellow vikings can see and connect to you(spiritually) | ||
|
||
![image alt](https://media.giphy.com/media/f4DfBGXTz0oD5K9DME/giphy.gif) | ||
|
||
--- | ||
|
||
### As a bored Viking you can: | ||
* read what your fellow vikings have posted | ||
![image alt](https://media.giphy.com/media/6IuokhEIj14bX13H3C/giphy.gif) | ||
|
||
--- | ||
|
||
### Are you an impulsive Viking? Are you worried you may have pissed someone off? Do you wonder what can you do? | ||
* Have no fear! We're currently working on a feature to deal with your impulsiveness. (also known as a delete button) | ||
![image alt](https://media0.giphy.com/media/hs33ZzTyQc5JC/giphy.gif) | ||
|
||
--- | ||
|
||
## Personal Learning Objectives | ||
|
||
### Ako | ||
- I have none, I am the learning objective | ||
![image alt](https://media.giphy.com/media/l4FGrYKtP0pBGpBAY/giphy.gif) | ||
|
||
### Hannah | ||
- Learn how the hell to use Node and tape | ||
|
||
### Lizzy | ||
- Develop an understanding of setting up a server on Node | ||
- | ||
|
||
### Roger | ||
|
||
|
||
___ | ||
|
||
## What we've done | ||
|
||
### First day: | ||
- Wrote everything we needed to do collaboratively on a HACKMD and then transferred into the project board each as small issues | ||
- Gave estimation labels to each issue, adding actual labels as each issue is completed | ||
- Keeping stretch goals out of the project board until we have a picture of what MVP we can achieve in the time given | ||
- As we go along we will be assigning ourselves to the issues we want to focus on, splitting the pairs this way | ||
- Mobbed deploying on Heroku as a whole team | ||
- Wrote HTML file structure in pairs | ||
- Mobbed creating our servers as a whole team | ||
|
||
### Second day: | ||
- Mobbed finishing the server | ||
- Split into pairs for first half of day | ||
|
||
### GITHUB COMMIT CREDITS | ||
Co-authored-by: @akomiqaia | ||
Co-authored-by: @hannahgooding | ||
Co-authored-by: @Lizzy-j | ||
o-authored-by: @Roger-Heathcote |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters