Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iharshit009/secretpeek
Anonymity is taken Seriously. It is a webpage to confess your secrets.
https://github.com/iharshit009/secretpeek
css flask html socket-io sql
Last synced: 10 days ago
JSON representation
Anonymity is taken Seriously. It is a webpage to confess your secrets.
- Host: GitHub
- URL: https://github.com/iharshit009/secretpeek
- Owner: iharshit009
- Created: 2020-12-05T13:58:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-20T05:32:45.000Z (over 3 years ago)
- Last Synced: 2024-10-11T14:31:57.221Z (27 days ago)
- Topics: css, flask, html, socket-io, sql
- Language: JavaScript
- Homepage:
- Size: 641 KB
- Stars: 8
- Watchers: 2
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SecretPeek
## Idea
Anonymity is taken Seriously!
It's a webpage to confess your feelings/secrets.
Speak out the things you never could
#### Currently the API is hosted [here](https://gsconfessions.herokuapp.com/)
#### It's a Django REST API which is just for dummy purposes
## Features
- [ ] Deploy API
- [x] Home Page to post and view confessions
- [ ] Convert into Progressive Web App(PWA)
- [ ] Create a textbar to write
- [ ] Read Count for confession
- [ ] Like feature for Confession
- [ ] Real-time sharing
## Tech Stack
- HTML
- CSS
- Flask
- Python
- Socket
Note: To know why we are using socket, please read [Polling and Streaming – Concept & Scenarios](https://www.geeksforgeeks.org/polling-and-streaming-concept-scenarios/)
## Installation
- Clone the repo
To run flask server
- run `pip3 install Flask`
- Run `python3 app.py`
If you have any issue/difficulty regarding installation kindly ping me on slack.
## Contribution Guidelines
Please raise a feature request or issue before sending PR for the same.
Follow the below guidelines for proper coding practices:
- Always [create a new branch](https://confluence.atlassian.com/bitbucket/branching-a-repository-223217999.html) for your changes and make PR from it ONLY.
- Write neat code with proper comments.
- Write descriptive commit messages. Please [read this](https://github.com/erlang/otp/wiki/writing-good-commit-messages) for more information.
- Write detailed PR messages and include `fixes #ISSUE_NUMBER` if it closes an issue, otherwise use `concerns #ISSUE_NUMBER` to tag the related issues. Please [refer here](https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/) for more PR guidelines.
- It is recommended to have a single commit for a task.
- Use [DRY principles](https://medium.com/@iharshit009/a-better-approach-the-dry-approach-d3a937c0fb8e) to create maintainable code.
## Communication
All contributors / users are requested to join [Slack Workspace](https://join.slack.com/t/secretpeek/shared_invite/zt-k44x2vnk-xTaE0q5LtG6tJXKL0z6kTg) for further discussion on ideas, PRs and issues.
For issues please raise a ticket in the issues tab in the [Secret Peek github repository](https://www.github.com/iharshit009/SecretPeek/issues).
The idea/features for this project are limitless. So don't hesitate to share your ideas. Also, this project appreciated all skill levels. So, looking forward to your active participation in this project.
Mentor for the project: [Pratya Chugh](https://www.github.com/pratyaa/) and [Harshit Jain](https://www.github.com/iharshit009/)