Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build an UI for this project. #16

Closed
nikhil25803 opened this issue Oct 1, 2022 · 19 comments
Closed

Build an UI for this project. #16

nikhil25803 opened this issue Oct 1, 2022 · 19 comments
Labels
enhancement New feature or request hard help wanted Extra attention is needed

Comments

@nikhil25803
Copy link
Member

Notes

  • Idea is to give this project a user interface on the root / path, as a landing page.
  • Create a templates folder and create all the UI-related files in that folder only.
  • The template folder must have an index.html file.
  • Before asking to get this issue assigned to you, please explain your idea in the comments below explaining the design(you may upload an image for reference) and the tech stack you are going to use.
  • Go through the contributing guidelines and make your contribution accordingly.
@nikhil25803 nikhil25803 added enhancement New feature or request help wanted Extra attention is needed hacktoberfest This issue is for hacktoberfest. hard labels Oct 1, 2022
@lostgirljourney
Copy link

lostgirljourney commented Oct 2, 2022

Hi, I want to discuss this. I am a frontend developer and I can do this using React using Next.js. Tho I don't know designing very well but we can look together for inspiration.

@nikhil25803
Copy link
Member Author

Sure @lostgirljourney
But instead of using a framework, we are looking to build the page using HTML, CSS, and JS only (you may use Bootstrap) so that we can render it easily as a template response in FastAPI. If you are okay with this, we can step ahead and discuss the design ideas.

@lostgirljourney
Copy link

Okay, here asked for the stack, so suggested React. And sure thing, we can go ahead with simple HTML, CSS, and JS, and it will be a new experience for me as well to work with the template response of FastAPI.

@nikhil25803
Copy link
Member Author

Great!
Assigning it to you and inviting you to the idea discussion page where we can discuss the design and once it is done, you can start working on it.

Just drop a Hi there :)

@lostgirljourney
Copy link

@nikhil25803 What exactly do you want to add to the website? Can you state that? That will give me an idea to proceed.

@nikhil25803
Copy link
Member Author

The homepage will look like this

  • Left side of the navbar - CollegeAPI.
  • Right side of the navbar - Discord and GitHub link (with logo)
  • The hero section includes written collegeAPI powered by Clueless Community in camel case with a brief description of it and on the right side of the hero section you can use any relevant SVG/PNG so that it doesn't look too minimal.
  • Something similar to what is shown below.

image

  • As it will be a single-page website, scrolling down, we can define our available routes and can show some sample output.

image


All of the things I mentioned are just for reference, feel free to use your creativity.
And yes, you can add this feature in multiple pull requests.

@lostgirljourney
Copy link

@nikhil25803 Got you. I will start over this, might take a bit of time as exams and office both gonna go simultaneously. :)

@nikhil25803
Copy link
Member Author

Sure @lostgirljourney !! No hurry :)

@rahulkarda
Copy link
Contributor

Hi @nikhil25803 , look at this UI that I made for my API. If you like it then I can share the template files with you for the college API. It's built using pure HTML, CSS, and JS.

Here's my API link: https://crypto-info-api.herokuapp.com/

@nikhil25803
Copy link
Member Author

It's really good @rahulkarda | You can ask @lostgirljourney and can work together.
But I want to tell you now only that, when this PR will get merged, the points will be given to her only.

@rahulkarda
Copy link
Contributor

rahulkarda commented Oct 9, 2022 via email

@nikhil25803
Copy link
Member Author

Glad to have contributors like you @rahulkarda bhaiya :)
You can use this page to discuss the idea with the team.

@rahulkarda
Copy link
Contributor

rahulkarda commented Oct 9, 2022 via email

@nikhil25803
Copy link
Member Author

Hey @lostgirljourney | Any update?

@lostgirljourney
Copy link

Hey @nikhil25803, I will start now. I was having exams.

@nikhil25803
Copy link
Member Author

Hey @lostgirljourney, there are only a few days left in Hactoberfest'22. Any updates?

@rahulkarda
Copy link
Contributor

Hey @lostgirljourney, there are only a few days left in Hactoberfest'22. Any updates?

Assign it to me if there's no update or I can help maybe.

@nikhil25803
Copy link
Member Author

Assigned it to you bhaiya :)) @rahulkarda

@rahulkarda
Copy link
Contributor

Assigned it to you bhaiya :)) @rahulkarda

Awesome! Will start working on it.

@nikhil25803 nikhil25803 removed the hacktoberfest This issue is for hacktoberfest. label Nov 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hard help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants