Skip to content

Latest commit

 

History

192 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chirper

MIT license GitHub forks Github all releases Netlify Status

Chiper Logo

Chirper is a Journal Entry web app that allows people intrested in discussing about sustainability of the planet. Users can submit Journal Entries with either text or a GIF from Giphy, react to other posts or leave comments on other entries.

Installation & Usage

Do the following:

  1. Clone or fork this repository
  2. Navigate to the root directory

For Clientside:

  1. Navigate to the client folder
  2. Before running for a first time do npm install
  3. To run the clientside use: npm run dev
  4. To run tests use: npm test

For Serverside:

  1. Navigate to the server folder
  2. Before running for a first time do npm install
  3. To run the serverside locally, use: npm run dev
  4. To run tests use: npm test
Please follow the README file instructions for client and server

Technologies

Languages used:

  • HTML & CSS
  • JavaScript
  • JSON

Client

Production Dependencies:

  • Bootstrap v5
  • Netlify for clientside deployment

Dev & Testing Dependencies:

  • watchify v4.0.0
  • concurrently v6.0.0
  • Jest

Server

Production Dependencies:

  • Node.js
  • Express.js
  • cors
  • Heroku - Hosting the API

Dev & Testing Dependencies:

  • Jest
  • Nodemon
  • Supertest

Process

  1. Brokedown key stakeholders requirements into individual tasks
  2. Brokedown these tasks into subtasks and created them on GitHub Projects Board
  3. Created a wireframe sketch-up on Photoshop: Here
  4. Created a more detailed design on Figma: Here
  5. Initial creation of repository
  6. Tasks assigned per day and completed following Git Flow
  7. Standup / end of day meeting to peer review

You can view our commit history of our main repo: Here

License

MIT License

Future Features

  • Filter by trending posts (most liked, most disliked, most tree reactions, most commented)
  • Sort journal entrties by date
  • Named journal entries
  • Filter according to user who created entry

Wins & Challenges

Wins:

  • Able to implement all core features
  • Styling, layout and visuals are all consistent and clean
  • Users are able to submit journal entries or GIFs
  • Users can comment on invididual entries
  • Reactions and comments are dynamically updated
  • Integration of Giphy API

Challenges:

  • Using a JSON file as the database
  • Making reactions dynamic and updating the count when someone reacts
  • Commenting feature
  • Testing with Jest Mock

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages