-
Notifications
You must be signed in to change notification settings - Fork 5
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 #35 from ReCoded-Org/readme-file
Readme file
- Loading branch information
Showing
1 changed file
with
109 additions
and
25 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,44 +1,128 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) template. | ||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
|
|
||
| ## Available Scripts | ||
| <div align="center"> | ||
| <a href="https://github.com/ReCoded-Org/capstone-turkey-react-bursapediary"> | ||
| <img src="https://user-images.githubusercontent.com/60944453/162048684-bbbe43f3-cd5b-4e93-908f-825ac7166ed1.PNG" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| In the project directory, you can run: | ||
| <h3 align="center">Bursapediary</h3> | ||
|
|
||
| <p align="center"> | ||
| <em> Dreams Will Come True</em> <br/> | ||
| </div> | ||
|
|
||
| ### `yarn start` | ||
| <!-- ABOUT THE PROJECT --> | ||
|
|
||
| Runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
| ## About The Project | ||
|
|
||
| The page will reload if you make edits.<br /> | ||
| You will also see any lint errors in the console. | ||
| Bursapediary makes it easy and safe for you to give support to local projects anywhere in the world, while providing nonprofits and individuals with the tools, training, and support they need to thrive. | ||
| <br> If you have dreams, Bursapediary is a right place for you. Find the support you need for your dreams with Bursapediary. If you are a supporter, meet with the dreamers and help their dreams to come true. | ||
|
|
||
| ### `yarn test` | ||
| <br> | ||
|
|
||
| Launches the test runner in the interactive watch mode.<br /> | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
| <div align="center"> | ||
| <a href="https://github.com/ReCoded-Org/capstone-turkey-react-bursapediary"> | ||
| <img src="https://user-images.githubusercontent.com/60944453/167108118-fb804964-6bf4-4e5c-96d7-04a3524e157c.png" alt="Logo" height="350"> | ||
| </a> | ||
| </div> | ||
| <br> | ||
|
|
||
| ### `yarn build` | ||
| ## Features | ||
|
|
||
| Builds the app for production to the `build` folder.<br /> | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| - Dynamic and interactive user input | ||
| - Interacting with an external API | ||
| - Multi-language support | ||
| - Unit tests via using react testing library | ||
| - Automated CI/CD | ||
| - Filter items by their category | ||
| - Login/Signup with authentication | ||
| - Filter projects by their category | ||
| - Comment on donation projects | ||
| - Add a new project based on the criteria | ||
|
|
||
| The build is minified and the filenames include the hashes.<br /> | ||
| Your app is ready to be deployed! | ||
| <br/> | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ### Built With | ||
|
|
||
| ### `yarn eject` | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
| <br/> | ||
|
|
||
| If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. | ||
| # Screenshots | ||
|
|
||
| You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
| ### Home Page | ||
|
|
||
| ## Learn More | ||
|  | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| ### Featured Projects Section | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|  | ||
|
|
||
| ### Sign Up Section | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### Contact Page | ||
|
|
||
|  | ||
|
|
||
|
|
||
| <br/> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## ⚡️ Getting Started | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/ReCoded-Org/capstone-turkey-react-bursapediary.git | ||
| ``` | ||
| 2. Navigate to the project folder | ||
|
|
||
| ```sh | ||
| cd capstone-turkey-react-bursapediary | ||
| ``` | ||
|
|
||
| 3. Install dependencies | ||
| ```sh | ||
| npm install | ||
| ``` | ||
| 4. Run the project | ||
| ```sh | ||
| npm start | ||
| ``` | ||
| 5. Run checks and tests | ||
| ```sh | ||
| npm test | ||
| ``` | ||
| ## Our Team | ||
|
|
||
| <p>We participated in all of the sprint planning sessions, virtual office time, retrospectives and standups. We also asked thought provoking questions and suggest many ideas in the capstone project period.</p> | ||
|
|
||
| | [<img alt="Maher" src="https://avatars.githubusercontent.com/u/18458259?v=4" width="115"><br><sub>@maqalaqil</sub>](https://github.com/maqalaqil) | [<img alt="Kutay" src="https://avatars.githubusercontent.com/u/63947758?v=4" width="115"><br><sub>@Iseluin</sub>](https://github.com/Iseluin) | [<img alt="Akin" src="https://avatars.githubusercontent.com/u/48355102?v=4" width="115"><br><sub>@theakinkavak</sub>](https://github.com/theakinkavak) | [<img alt="Hatice" src="https://avatars.githubusercontent.com/u/57989556?v=4" width="115"><br><sub>@haticecs</sub>](https://github.com/haticecs) | [<img alt="Orkun" src="https://avatars.githubusercontent.com/u/62790332?v=4" width="115"><br><sub>@orkunseyman</sub>](https://github.com/orkunseyman) | [<img alt="Ozer" src="https://avatars.githubusercontent.com/u/60944453?v=4" width="115"><br><sub>@OzerOzturk</sub>](https://github.com/OzerOzturk) | [<img alt="Teoman" src="https://avatars.githubusercontent.com/u/44370085?v=4" width="115"><br><sub>@bayogluteoman</sub>](https://github.com/bayogluteoman) | ||
| | :---------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------: |:--------------------------------------------------------------------------------------------------------------------------------------------:| | ||
|
|
||
|
|
||
|
|
||
|
|