israelias / cheathub

Web app for organizing code snippets, with Flask/Python backend, with React/Typescript frontend

class ReadMe:
    def __init__(self, username="israelias", year=2022):
        self.username = username
        self.year = year
        self.name = 'Joem Elias Sanez'
        self.education = {
            'programming': ['Full Stack Software Development', 'Code Institute'],
            'architecture': ['Master of Architecture', 'Columbia University'],
            'art': ['Bachelor of Fine Arts', 'Otis College of Art and Design']
        }
        self.employment = {
            'engineer': ['ResultsCX', ['Manila', 'Fort Lauderdale']],
            'architect': ['Foster + Partners', ['Singapore', 'New York']],
            'designer': ['Herzog & de Meuron', ['New York', 'Basel']],
            'all of the above': ['you', ['projects', 'anywhere']],
        }

    def doing(self, now=2023):
        today = self.year

        if now < today:
            experience = self.employment['architect']
            return """
            I was a design architect with {large_firms} in {big_cities}.
            """.format(large_firms=experience[0], big_cities=experience[1][0])

        elif now == today:
            dream = self.employment['engineer']
            return """
            I am currently in Application Development for {tech_enabled_services} in {remote_settings}.
            """.format(tech_enabled_services=dream[0], remote_settings=dream[1][0])

        elif now > today:
            goal = self.employment['all of the above']
            return """
            I am eager to collaborate with {teams} on {projects} {everywhere}.
            """.format(teams=goal[0], projects=goal[1][0], everywhere=goal[1][1])
        else:
            return """
            ### Hi there 👋
            """
        
    def collaborate(self, role, organization, location):
        opportunity = self.employment
        opportunity[role] = [organization, location]

me = ReadMe(2022)

cheathub's Issues

Browse All Collections Feature

Currently, you can browse everyone's snippets, but you can only view your own collections of snippets. It would be fairly straightforward to inherit the same logic for an all collections search/page on the front end.

• Add search index for collection names and owners in Collection model
• Add like field to Collection model
• Create endpoint with pagination
• Develop frontend search collections page

Subdirectory Package Support

Make it easy to clone frontend without backend and vice versa.

Yarn workspaces is the obvious way to go but a package.json in a Python/Flask backend subdirectory would be relatively useless...

• Add root package.json
• Add backend package.json
• Modify frontend package.json name to work with yarn workspaces from root directory
• Add start scripts in root package.json to run development frontend, backend, and both concurrently.
• Add scripts to backend/package.json that run the various subdirectory python commands for development and production
• Add build scripts in root package.json to run build commands of respective subdirectories
• Add test scripts in root package.json to run test commands of respective subdirectories

Convert Backend Script to Github Action

Current backend deployment is done manually for Heroku, and each Heroku git is removed upon each successful deployment. This should be converted to a GitHub action that runs separately from a frontend branch.

Add OpenAPI Spec

Add Swagger documentation to / endpoint of backend deployment.

• @marshal_with resources using Flask Restful Swagger. I think it could suffice having just quickly browsed the docs
• Point the spec to the index page of backend api

Improve User Authentication and Field Validation

• Disallow emails as usernames
• Add email authorization
• Add reset password endpoint
• Add social account authorization ?

Stratify Deployment Triggers

Organize branches so deployments aren't triggered on all pushes to master.
Further stratify production and development in named branches accordingly and on Vercel dashboard.
Further stratify branches for backend updates to Heroku.

GitHub actions.