Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 4.19 KB

README.md

File metadata and controls

121 lines (87 loc) · 4.19 KB
Raw

THE-CASE-FILES

Empowering Minds, Exposing Truths: Navigating College Life Safely

Model Link

Welcome to CredLock 🎓

CredLock is a thriving haven for college students, fostering a supportive community that nurtures personal growth and academic excellence. Our mission is deeply rooted in empowering students through shared experiences and valuable educational resources.

About CredLock 🎓

At CredLock, we believe in creating a vibrant community where students are active contributors to each other's learning journey. Here's what sets us apart:

Basic Features

  • User Registration and Login: Begin your journey by creating a personal profile on CredLock.
  • Blog Creation: Unlock your creativity with intuitive tools to craft and publish your blog posts.
  • Content Editing: Customize your content with ease using text formatting options and image upload functionality.
  • Comment Section: Foster discussion and interaction with dedicated comment sections for each blog post.
  • Search Functionality: Navigate the wealth of content with ease using our search functionality.
  • Following System: Build connections and curate your personalized feed by following other bloggers.

Advanced Features

  • Content Categorization: Organize your blogs under specific themes for enhanced organization and discovery.
  • Analytics Tools: Track the performance of your blog with insights into views, comments, and user demographics.
  • Social Media Integration: Share your blog posts effortlessly across popular platforms, amplifying your reach.

Join CredLock

Join us at CredLock and embark on a shared adventure of knowledge, connection, and growth. Together, let's make learning a collaborative and enriching experience.

Usage

  • Create a MongoDB database and obtain your MongoDB URI - MongoDB Atlas

  • Create a Cloudinary account and obtain your API_KEY API_SECRET and Create FOLDER_NAME by you won - Cloudinary

  • Get CLIENT_ID CLIENT_SECRET REFRESH_TOKEN from Google Developer Console

Env Variables

create the .env file inside server directory and add the variables that has been mentioned in .env.sample

Change the JWT_SECRET to whatever you want.

Install Dependencies (frontend & backend)

cd server
npm install
cd ..
cd client
npm install

Run


# Run backend (:4000) & frontend (:3000)
cd server
npm run server

# Run frontend
npm run start

Build & Deploy

# Create frontend prod build
npm run build

Contributing to CredLock 🎓

We welcome contributions from the community to improve CredLock. To contribute, please follow these steps:

1. Fork the Repository

Start by forking this repository to your GitHub account.

2. Create a New Branch

Before making any changes, create a new branch from the main branch. Use a meaningful name for your branch:

bash
git checkout -b feature/your-feature-name

3. Make Your Changes

Once you're in your new branch, you can start making the necessary changes or adding new features. Make sure to follow the coding conventions and best practices of the project.

#### How to work on your changes:
- Modify the codebase to implement the feature, fix, or update.
- Test your changes thoroughly.
- Ensure your code is clean and formatted according to the project's guidelines.

4. Commit Your Changes

Once you've made and tested your changes, stage and commit them using a descriptive commit message.

Commands to commit your changes:
git add .
git commit -m "Descriptive message explaining the changes"

Make sure your commit message is clear and reflects the purpose of the changes you've made.

5. Push to Your Fork

Push your branch to your forked repository:
git push origin feature/your-feature-name

6. Submit a Pull Request

Go to your forked repository on GitHub and submit a pull request to the original repository.

Provide a clear description of the changes you've made.
Link any relevant issues if applicable.
Request a review from the project maintainers.