Skip to content

Latest commit

 

History

History
125 lines (81 loc) · 4.49 KB

README.md

File metadata and controls

125 lines (81 loc) · 4.49 KB
Raw


KnowNative

Transform your language learning with real-world articles written by native speakers. KnowNative personalizes your study experience with automatically generated flashcards, inline annotations and context-driven translations, creating tailored learning tools that are uniquely yours.

- Live Demo -

About the project

KnowNative is a web application built by Abigail Dawson, maintained by our Core Contributors and the broader open-source community.

Built with:

  • Node
  • Express
  • React
  • MongoDB

Running KnowNative locally

Run KnowNative locally with the following steps:

Prerequisites

npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/AbigailDawson/knownative.git

2. Install all packages

cd client
npm i
cd server
npm i

3. Create a .env file in the server folder.

Your .env file will need the following variables:

  • MONGODB_URI contains the connection string for MongoDB. Learn how to connect.
  • GOOGLE_TRANSLATE_API_KEY contains the API key for sentence translations. Get a key.

4. Build & run the client

cd client
npm run build
npm run start

5. Run the server

cd server
npm run dev

(back to top)

Contributing to the open-source project

KnowNative can only improve with fresh perspectives and creative insights from contributors! We welcome any suggestions, fixes and improvements that can make KnowNative an even better resource for learners.

To contribute to the project, please fork the repo, make changes and create a pull request. You can also open an issue through GitHub if you'd simply like to submit an idea or report a bug.

  1. Fork the project
  2. Create your own branch (git checkout -b <yourbranchname>)
  3. Commit your changes (git commit -m 'About your contribution')
  4. Push to the branch (git push origin <yourbranchname>)
  5. Open a pull request to merge into develop

Don't forget to give the project a star while you're at it!

Core Contributors

As the creator of KnowNative, I am eager to collaborate with others who are excited about this project and are looking to contribute to on a more regular and consistent (volunteer) basis. We currently have a small team of Core Contributors who are innovating behind the scenes to bring high quality features and exceptional user experience to KnowNative. Read more here: Core Contributors.

Becoming a Core Contributor is an excellent way to gain real-world experience working with a team and add to your own portfolio or resume, all while being a part of a project you're passionate about! I'm currently open to Core Contributors with skills in:

  • UX/UI research and design
  • Software development
  • Branding, social media and marketing
  • Those with a special interest in linguistics and language learning - if you'd like to contribute, I'd love to hear from you!

Core Contributors benefit from the following:

  • Special recognition on our website, with your image, bio and professional/social links
  • Experience working solo or in small groups
  • Weekly group coding sessions

To be considered a Core Contributor of the KnowNative project, developers must commit to submitting one meaningful PR per month and attend at least one team meeting or 1:1 check-in per month. Participation is voluntary, and these requirements are in place to ensure harmonious collaboration among team members who are serious about the project. There is no minimum commitment for hours/week or number of months, and all experience levels are welcome.

To chat about becoming a Core Contributor, please reach out to me on LinkedIn. Please include something in your message about how your interests align with the project's mission.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Abigail Dawson · LinkedIn · [email protected]

(back to top)