Advocat

She Codes crowdfunding project - React front end.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Project Submission
4. Roadmap
5. Contributing
6. Contact

About The Project

This project is the front end of a crowdfunding website which has been created to support people with raising funds for their furry children's medical expenses. You can find the back end repository here.

(back to top)

Built With

• 

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/rosiemaguire/crowdfunding-frontend.git

2. Navigate to the repo directory and install NPM packages

   npm install

3. Run the server

   npm run dev

(back to top)

Project Submission

• A link to the deployed project
  • Deployed site
• A screenshot of the homepage
  • 
• A screenshot of the project creation page
  • 
• A screenshot of the pledge creation form
  • 
• A screenshot of a project with pledges
  • 
• A screenshot of the resulting page when an unauthorized user attempts to edit a project (optional, depending on whether or not this functionality makes sense in your app!)
  • The edit project link is not visible on project page if user is not owner
  • If a user that is not the owner navigates to project update page using the URL, this will redirect to a 404
  • 

(back to top)

Roadmap

• Profile page with authenticated user's basic details & associated projects
• Have function that calculates total donations
• Have function that grabs most recent three pledges to display on Project Page
  • Button to toggle view to see all pledges under3 recent pledges (similar to what has been done with projects on home page)
• Implement carousel for recent projects on home page
• Check if username is already in use on the handle change, prior to post request being made for new user creation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Rosie Maguire - @rosie_maguire

Project Link: https://github.com/rosiemaguire/crowdfunding-frontend

(back to top)