Fake Authentication Api

Supercharge your frontend development with Fake Authentication API: Simple login/signup for your projects!

👾 Motto

Developing front-end applications without key features like login and signup isn't ideal. Nowadays, every web app needs these basics. But for beginners, making them work can be tough. Creating backend APIs for just the front end is not easy, and it takes a lot of time. So, I created this Fake Authentication API. These APIs will help beginners and those who want to test front-end apps. It makes implementing login and signup functionalities easier without dealing with complex backend stuff. With this, anyone can get started quickly and save time, making web development smoother for everyone, regardless of their experience level.

📚 More Info

This project includes Swagger, a powerful tool for understanding each and every API. Swagger provides detailed documentation for every endpoint, making it easier to navigate and use the APIs effectively.

Note

End point for Swagger Documentation /api/api-docs.
You can explore Swagger Documentation at Fake Authentication API's Swagger Documentation.

👁️ Important Note

After creating superadmin account if it is inactive for 28 days then superadmin account along with it's all associated data will be deleted.

⚙️ Local Setup

Step 1

• Log in to your MongoDB Atlas account via Mongo DB Atlas
• Create a new project in MongoDB Atlas.
• Create a cluster within the designated project. (You have the option to select either a free or a paid cluster)
• Within the Collection section of the cluster, create a database with the following collections.
• Give database name as FakeAuthenticationDB and collection name as dynamicUsers.
• Clik on Create button.
• Now you will see a ⊕ at the top left beside the database name. Click on that icon to create more collections.
  
• When you click on that icon it will open a pop up modal where you can enter the collection name and click on Create button. Repeat this twice with other two collection names as following: dynamicUsersData and staticUsers
  

Step 2

• By clicking on the Connect button, Copy the Connecion String from the overview page.
  
• Now clone this repo to your local system and open that in VS Code.
• Rename the .env .txt file into .env
• Paste the connection String that you copied earlier to MONGO_URI in .env file
• Now run these commands

npm install
npm start

🪄 Contribution Guidelines:

Check the Contributing Guide out.
Head over to issue tracker to check more about it.
We expect all contributors to abide by the terms of our Code of Conduct.

🛡️ License

This repository is licensed under the MIT license.
Illustrations by StorySet bring our Fake Authentication API Website to life!