Our mission is to make it easy for developers to write high quality code. CodeClippy is an Atom plugin that aims to act as a gateway for enabling this vision.
Initially, CodeClippy will provide access to SolutionLoft's querying engine of indexed StackOverflow questions and answers, allowing the user to interact with StackOverflow Q/A without leaving the comfort of his or her editor.
This section contains instructions for manually installing CodeClippy locally. After the initial alpha test, CodeClippy will be made public on Atom's package repository.
-
Please have the Atom editor installed locally. Visit Atom.io to download the latest version.
-
Please have
apm, the Atom Package Manager, installed to your command line. To do so, navigate toAtom > Install Shell Commandsin the application menu. To check thatapmwas installed, runapm -v. -
Please have
npm, the JavaScript package manager, installed to your command line. See instructions for various ways of installing here.
- Clone the CodeClippy plugin.
- Navigate inside the CodeClippy directory and run
apm link. This will create a symbolic link to your~/.atom/packagesfolder. - From inside the CodeClippy directory, run
npm installto install the necessary node modules. - Return to the Atom editor and reload the window. You can do this by pressing
CMD-Shift-Pand enteringWindow: Reload. You will need to do this every time you make changes to the package.
To activate the plugin, press CMD-Shift-H. This will open up a right side panel.
The panel is resizable. To look up StackOverflow threads, enter a query in the
search bar and press enter. You can expand questions by clicking the Expand button
on the bottom right of each question. You can expand and collapse comments and answers
similarly.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
There you will soon find instructions for getting set up to develop locally.
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.