djm-1 / secretpeek

Anonymity is taken Seriously. It is a webpage to confess your secrets.

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

It's a Django REST API which is just for dummy purposes

Features

• Deploy API
• 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

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 for your changes and make PR from it ONLY.
• Write neat code with proper comments.
• Write descriptive commit messages. Please read this 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 for more PR guidelines.
• It is recommended to have a single commit for a task.
• Use DRY principles to create maintainable code.

Communication

All contributors / users are requested to join Slack Workspace for further discussion on ideas, PRs and issues.

For issues please raise a ticket in the issues tab in the Secret Peek github repository.

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 and Harshit Jain