Skip to content

brrkrmn/codeandline-frontend

Repository files navigation


Code and line logo
Code&Line

Code and line's github stars />
  </a>
  <a href= Berra Karaman's Buymeacoffee link

Code&Line is a note-taking app designed for developers to provide a more detailed understanding of their code. Its core feature allows users to target specific code lines with each note, aiming for a line-by-line explanation of the snippet.


Code&Line - Note-taking app for developers | Product Hunt


Table of Contents


Development Setup

To clone and run this project, you'll need Git and Node.js (which comes with npm) installed on your computer.


Setting up Frontend

  1. Clone frontend repo
git clone https://github.com/brrkrmn/codeandline-frontend.git
  1. Go into the repo
cd codeandline-frontend
  1. Install dependencies
npm install
  1. Run the app
npm start

Setting up Backend

  1. Clone the repo
git clone https://github.com/brrkrmn/codeandline-backend.git
  1. Go into the repo
cd codeandline-backend
  1. Install dependencies
npm install
  1. Initialize your MongoDB database manually
  2. Set up environment variables
    • Create .env file in the root of the project
    • Include the following variables in your .env
    PORT = 3001
    MONGODB_URI = <your mongodb uri>
    TEST_MONGODB_URI = <your test database uri>
    SECRET = <your secret>
  3. Run the server
npm run dev

Running Tests

npm test

Contributing

Code&Line is an open-source project, and your help is always welcome! I encourage you to go through the Contribution Guidelines and check out the Ideas for Improvement section.


Ideas for Improvement

  • Display verification modal on delete (folders and notes)
  • Password reset
  • Profile page
  • Add other authentication
  • Add Light theme
  • Add tests
  • Auto save (folders and notes)
  • Public notes and folders
    • upvoting
    • explore page

Resources


License

Licensed under the MIT License.