fitdevs-withkat / fitness-accountability Goto Github PK

View Code? Open in Web Editor NEW

80.0 2.0 97.0 1.23 MB

Home Page: https://fitdevs-withkat.github.io/Fitness-Accountability/

JavaScript 6.65% CSS 2.01% TypeScript 91.33%

fitness-accountability's Introduction

Fitness-Accountability @ #FitDevs

Discord | Twitter

Quick Introduction

Quick access index

Step 1 - Creating a JSON file
Step 2 - Inputting information in the JSON file
Step 3 - Committing the file
Step 4 - Create a pull request

Step 1 - Creating a JSON file

First, click on the data folder of this repository

Then, create a new file by clicking Add file and then Create new file

Then, name the new file as your Github username followed by .json such as win21H2.json

↑ Go to top ↑

Step 2 - Inputting information in the JSON file

In the file you just made, copy and paste the template:

{
  "name": "",
  "url": "",
  "image": "",
  "why": "",
  "weekly": [],
  "goal": "",
  "location": ""
}

and fill out the information with the help of the below notes

Name: You can use your github name, actual name, or a pseudonym!

Url: Please insert Github link here, we will expand the user json files to include socials in the future

Image: You can use any appropriate profile image here (make sure it is a valid image URL e.g. https://github.com/win21H2.png)

Why: Please write down your reason why you have joined the #FitDevs community!

Weekly: Your goals for fitness, can be food/exercise/mental/emotional, whatever fitness means to YOU

Such as the below

["Running 6x", "Abs 6x", "Pushups 6x"]

or

["Drinking 500ml Water 3/day", "Meatless Mondays 2x/month", "Sleeping 7h 6/week"]

Please make sure to use commas in between each goal otherwise it would break the JSON file

Goal: What is your overarching goal?

Location: Be as vague or as specific as you would like to

A full example below:

↑ Go to top ↑

Step 3 - Committing the file

Make sure that before you click the Propose new file button, that you have made the below changes:

Fill out the title, this can just be Create [USERNAME].json
Fill out a summary, this can just be Added information to my JSON file
Create a new branch and name it something like [USERNAME]-my-card and start a pull request by clicking the Propose new file button.

↑ Go to top ↑

Step 4 - Create a pull request

By now, you should be brought to a new page, click the green Create pull request button and if everything works, it should look like the last image. Congrats! you have just created your own "card" which will manually be reviewed by a member of the Github team and will be merged! Once your pull request has beeen merged, you will be able to see it on the main website.

Find this example in this sample pull request

If there are any issues such as ones related to this guide, please create an issue and we will try to fix it as fast as possible!

Thanks,
The #FitDevs GitHub team

↑ Go to top ↑

fitness-accountability's People

Contributors

Stargazers

Watchers

Forkers

eddiejaoude himanshubalani jiochoa maryamfarshbafi haideralipunjabi the-lazy-learner janet-dev jaclynbrothers bishal7679 cookiesntech khardikk nathyg2524 advait-cs alexmainamunyua anantluthra yohn-cheung particus17 fit-devs-with-kat carlosepicsounds amelia2802 codingcomrade swxstikk stefanintech joshuahallee shivam-katare ruchip16 raunaqkapoor charanmn7 ashmint scottjwilson kantarcise zachfrenesdev kvncnls liy-che hhthacker noobyco khazifire abbas-khann jasminepvo aparna2071 afoxbr lorenzejay kelvinparmar namyakhan pranaysewatkar nataliepina micahbear jsmarsh813 johngreen-dev kartikgajjar7 souravjain540 gandhiv88 sharifataimur vipul-bhardwaj777 mojoelogic r-augustine kantiprasanna neha7544 lubnafathima breabang lovethtee jameslieu code-with-onye ubaidrussell yusufthetechie marisabrantley emilyjspencer kihuni omer-cakmak jp-sdev rembertdesigns ohhkaneda davidmyersdev joachimchisom1 aspirebyjare cheloghm abbeyit rohitg00 hikari7 hawelkam akebu6 siddhantkhariwal dhanushnehru legenddevmatt gentlegiantdev lawrencedcodes yuricodes paraggaikwad11 knshkp ayushi15-vamne camilingjs michagodfrey shrutikmhatre saadnajm alexkates coolridgeryan

fitness-accountability's Issues

[FEATURE] Use `JSON` Files to render webpage

The JSON-Files can be used to pass in data to an actual website.
As the data are static (at least for now), we can leverage SSG, which would also enable us to host the page on Github Pages for now.

There are a few Static-Site-Generators out there, I'd suggest going with Next.js as the adoption rate of React & Next.js is quite high.

Add lang attribute to html

The html tag is currently missing the lang="en" attribute.

Suggested change: <html lang="en">

Add Issue template.

Issue template is required.

bug: capitalize first letter of name

Setup Prettier

Add link of live project

add link of the live running project in about section

Guide for a JSON file

Making a JSON can at times be a bit complicated. So we can add a Guide to make a .json file in the documentation section.

Add a main tag around the main content

This div: <div class="container mx-auto"> should be changed to <main class="container mx-auto">

Use Typescript

Good practice and helps catches bugs in the long run

Add Code of Conduct

There needs to be a nice code of conduct

Remove Wiki for now

OneMillionMinutes - add page for weekly leadership board

The Twitter bot is collecting a copy of entries logged weekly for #OneMillionMinutes and clears it every Monday 12AM EST. We need to add a page to our website that displays a leadership board with this data.

Add a description of the project

Setup: Husky

Placeholder Text for JSON Template

Add placeholder text, examples in the json template

Feat: add heading to the website

I recommend adding some headings, such as "Fit Devs" or "Fitness Accountability."

Suggestion: add padding to container

may way to add some padding to create some space esp in mobile maybe px-2 or py-4

Closing because ui/ux designs are wip

Change to using Next/Image requires a width or height if not using layout `fill`

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [Version 104.0.5112.79 (Official Build) (arm64)]

Add logo to organisation.

Add a logo to the main github organisation.

Using next/image has introduced a problem

Describe the bug

1st Issue

The first issue is the Next/Image component requires the width and height properties.

2nd Issue

When clicking into a profile, Next/Image component requires that you define the hostname of a given src in the images.domains config in next.config.js, the problem with this is that if a user wants to use an image from an alternate source like their personal website, or twitter or FB, you would need to add that hostname into the config, so there is a huge restriction placed when using this component. https://nextjs.org/docs/messages/next-image-unconfigured-host

https://nextjs.org/docs/messages/next-image-unconfigured-host

To Reproduce
Steps to reproduce the behavior:

Go to the landing page
Click on a profile

Expected behavior
The page should load.

Proposed solution

Revert the element back to img, there is a eslint warning which states to either use the next/image component or to use in conjunction with element:

https://nextjs.org/docs/messages/no-img-element

Suggestion: Daisyui with tailwind

I think https://daisyui.com/ would be beneficial to use since it helps make developing easier along with custom themes

Github action for linting JSON files in data folder

There is a need for a GitHub workflow that flags a PR when the .json file added to the data folder has syntax errors.
PRs that are merged with syntax errors can break the application.

The action from https://github.com/EddieHubCommunity/LinkFree/blob/main/.github/workflows/prettier.yml can be adopted for this repository.

in reference to: #8 #10

head is missing a title tag

Add a title tag inside the head tags with a page title

[Docs] : Styling issues in the README

There are some instances where there are styling inconsistencies or bugs.

feat: order and filter list

option to order by name, username, location

Add License

Maybe, we could add a permissive license and a code of conduct among other things?

Suggestion: Environment setup

Might be worth mentioning how to set up the application and run it in the README along with links to the documentation

and helpful extensions ie vscode: tailwindcss intellisense , prettier, etc

Implement Dark-Theme

remove emoji from Detail

Please remove that emoji, as this can't be displayed with all Devices/Browsers/Fonts

feat: add a title in the page

right now it's just the list

feat: add icon

add icon once logo has been decided

Add a Discord link on README

Page is not responsive for max-width:800px

The right border of each user profile isn't responsive for max-width:800 px

Viewport is missing

The display scaling of the website doesn't look right on mobile phones. I checked the code, the index.html is missing the viewport meta tag. I believe that's what is causing this problem:

Add a screenshot of .Json file whith value in it.

Add a screenshot of .Json file whith value in it for refrence to make it more easier for people to add their profile.

Location Emoji not rendering on some devices

This emoji 📍 , won't render on devices that don't have support for emojis. I will recommend adding an emoji font like Noto Emoji. If someone has better suggestions for the emoji font, something with coloured emojis and open source preferably, please recommend them.