Archived
Update Readme
This commit is contained in:
1 parent
04a83abc78
commit
1d02a28f45
1 file changed
+20
-53
@@ -1,40 +1,31 @@
|
||||
# Project Name
|
||||
> Outline a brief description of your project.
|
||||
> Live demo [_here_](https://www.example.com). <!-- If you have the project hosted somewhere, include the link here. -->
|
||||

|
||||
|
||||
> Eco-Meet - _For the environment_.
|
||||
|
||||
## Table of Contents
|
||||
* [General Info](#general-information)
|
||||
* [Technologies Used](#technologies-used)
|
||||
* [Features](#features)
|
||||
* [Screenshots](#screenshots)
|
||||
* [Setup](#setup)
|
||||
* [Usage](#usage)
|
||||
* [Project Status](#project-status)
|
||||
* [Room for Improvement](#room-for-improvement)
|
||||
* [Acknowledgements](#acknowledgements)
|
||||
* [Contact](#contact)
|
||||
<!-- * [License](#license) -->
|
||||
|
||||
|
||||
## General Information
|
||||
- Provide general information about your project here.
|
||||
- What problem does it (intend to) solve?
|
||||
- What is the purpose of your project?
|
||||
- Why did you undertake it?
|
||||
<!-- You don't have to answer all the questions - just the ones relevant to your project. -->
|
||||
|
||||
- The App was created for the mini Hackathon - edycja I organised by Nowa Akademia.
|
||||
- Eco-meet is a meeting platfrom designed to solve the environmental issue.
|
||||
- The purpose of our project is to have people cooperate for the couse of saving our planet.
|
||||
|
||||
## Technologies Used
|
||||
- Tech 1 - version 1.0
|
||||
- Tech 2 - version 2.0
|
||||
- Tech 3 - version 3.0
|
||||
- React - version 17.0.2
|
||||
- MongoDB - version 4.1.2
|
||||
- Bootstrap - version 5.1.1
|
||||
- Express - version 4.17.1
|
||||
|
||||
|
||||
## Features
|
||||
List the ready features here:
|
||||
- Awesome feature 1
|
||||
- Awesome feature 2
|
||||
- Awesome feature 3
|
||||
- Create custom environmental events the community can participate in.
|
||||
|
||||
|
||||
## Screenshots
|
||||
@@ -42,48 +33,24 @@ List the ready features here:
|
||||
<!-- If you have screenshots you'd like to share, include them here. -->
|
||||
|
||||
|
||||
## Setup
|
||||
What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?
|
||||
|
||||
Proceed to describe how to install / setup one's local environment / get started with the project.
|
||||
|
||||
|
||||
## Usage
|
||||
How does one go about using it?
|
||||
Provide various use cases and code examples here.
|
||||
|
||||
`write-your-code-here`
|
||||
Simply visit our internet website ecomeet.me and start saving our planet!
|
||||
|
||||
|
||||
## Project Status
|
||||
Project is: _in progress_ / _complete_ / _no longer being worked on_. If you are no longer working on it, provide reasons why.
|
||||
Project is: _in progress_
|
||||
|
||||
|
||||
## Room for Improvement
|
||||
Include areas you believe need improvement / could be improved. Also add TODOs for future development.
|
||||
|
||||
Room for improvement:
|
||||
- Improvement to be done 1
|
||||
- Improvement to be done 2
|
||||
- UI
|
||||
|
||||
To do:
|
||||
- Feature to be added 1
|
||||
- Feature to be added 2
|
||||
- feature to share images on the portal taken on the event.
|
||||
- tag feature for users who stand out in the community for they their effort put in saving our environment.
|
||||
- news feature to be able to track the environment status.
|
||||
- achievement feature.
|
||||
- follow/liking system.
|
||||
- chatting feature.
|
||||
|
||||
|
||||
## Acknowledgements
|
||||
Give credit here.
|
||||
- This project was inspired by...
|
||||
- This project was based on [this tutorial](https://www.example.com).
|
||||
- Many thanks to...
|
||||
|
||||
|
||||
## Contact
|
||||
Created by [@flynerdpl](https://www.flynerd.pl/) - feel free to contact me!
|
||||
|
||||
|
||||
<!-- Optional -->
|
||||
<!-- ## License -->
|
||||
<!-- This project is open source and available under the [... License](). -->
|
||||
|
||||
<!-- You don't have to include all sections - just the one's relevant to your project -->
|
||||
Reference in new issue
Block a user