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

[New API] : Visitor Counter API #301

Closed
4 tasks done
mondalsurojit opened this issue Jun 23, 2024 · 2 comments · Fixed by #303
Closed
4 tasks done

[New API] : Visitor Counter API #301

mondalsurojit opened this issue Jun 23, 2024 · 2 comments · Fixed by #303
Labels
awesome gssoc New label for GSSOC-24 level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS newapi Denotes the new api is there

Comments

@mondalsurojit
Copy link
Contributor

Brief Description 🤓

This project is a serverless API hosted on Netlify using Redis Cloud as the database. The API allows for managing a simple counter that can be incremented, reset, or retrieved on page load. It supports CORS for cross-origin requests.

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSOC'24 contributor
  • I want to work on this issue

How will you develop it?🤩

I have already developed it, and its hosted on Netlify: https://visitor-counter-api.netlify.app/.netlify/functions/counter/

But for further clarity, I am giving a brief description, how I developed and hosted it:

  1. Design the API Structure:

    • Define the endpoints (GET / and OPTIONS /) and their functionalities.
  2. Set Up Serverless Environment:

    • Choose a serverless platform (Netlify) for hosting the API.
  3. Database Integration:

    • Select Redis Cloud for managing the counter data.
    • Configure the connection to the Redis database.
  4. Implement API Logic:

    • Write the logic to handle incrementing, resetting, and retrieving the counter value.
    • Implement error handling for database interactions.
  5. Enable CORS:

    • Ensure CORS support to handle cross-origin requests.
  6. Environment Configuration:

    • Use environment variables to store sensitive data (e.g., Redis credentials).
  7. Local Development and Testing:

    • Develop and test the API locally using tools like Netlify CLI.
  8. Deployment:

    • Deploy the API to Netlify and configure environment variables through the dashboard.
  9. Documentation and Maintenance:

    • Document the API endpoints, environment variables, and error handling.
    • Plan for ongoing maintenance and updates.

Deployment

Yes

Select the open source program you are contributing to

Other

Code of Conduct

@dishamodi0910
Copy link
Owner

Greetings @mondalsurojit🎀 ! , We are excited to have you dive into another issue with us!🚀
Your involvement in our project has been invaluable, and we're confident that your skills and insights will help us conquer this challenge😇.

Use command /gssoc24 to self assign the issue.

This issue represents an exciting opportunity for us to improve and enhance our project, and we are thrilled to have you on board.
We request you to follow CONTRIBUTING GUIDELINES.
Looking for your PR soon!
In case of any issues, you can contact us on Discord.❣️

@dishamodi0910 dishamodi0910 added awesome gssoc New label for GSSOC-24 level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS newapi Denotes the new api is there labels Jun 23, 2024
@dishamodi0910
Copy link
Owner

Hey @mondalsurojit ! I wanted to inform you that we have closed issue.Thank you for your understanding, and we look forward to your continued engagement with our repository🤗.
In case of any issues, you can contact us on Discord.
Thank you! ❣️
Happy Coding! ✨
Will See you soon❣️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awesome gssoc New label for GSSOC-24 level3 NEW API/3 EXISTING API ENHANCEMENTS/5 BUGS newapi Denotes the new api is there
Projects
None yet
2 participants