evernote-clone

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #golang #machine-learning #rust #linux #macos #java #windows #security #openai

(★ 19)

Simple Evernote Clone

evernote-clone 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# KLEVERNOTE

## About

Klevernote is a clone of the popular note-taking app, Evernote.

## [Live Link](https://klevernote.herokuapp.com/)

![](https://raw.githubusercontent.com/mjshuff23/evernote-clone/main/documentation/Klevernote-Overview.gif)
## Collaborators

- [Bonnie Hardie](https://github.com/bonniehardie)
- [Harrison Higgins](https://github.com/the-harry-higgins)
- [Cynthia Spence](https://github.com/cynthiaspence7827)
- [Michael Shuff](https://github.com/mjshuff23)

## Technologies Used

### Frontend

- Material-UI
- React
- React-DOM
- Redux
- React-Quill

### Backend

- Python
- Flask
- SQLAlchemy
- Alembic
- PostgreSQL
- Gunicorn
- Docker
- Heroku

## Features

### MVP Features

#### 1. NOTES

Users can create, edit, and delete Notes.

#### 2. NOTEBOOKS

Users can save Notes in collections called Notebooks. Users can create, edit, and delete Notebooks.

#### 3. TAGS

Users can create and delete Tags as well as add or remove them from Notes.

#### 4. RICH-TEXT EDITING

Rich-text editing allows users to view their Note's styling and formatting as it will appear in its final form.

#### 5. AUTO SAVE

Any editing done to a note is saved automatically.

### Potential Future Features

1. Search (Notes, Tags, Notebooks)
    2. Sorting (Alphabetical, Recent)
    3. Note Templates

***

## Useful Links

- [Database Diagram](./documentation/dbdiagram01.png)
- [Feature List](./documentation/feature-list.md)
- [React Component Tree](./documentation/components.md)
- [Redux Store](./documentation/redux_store.md)

***

## Dev Instructions

### Getting started

1. Clone this repository (only this branch)

```bash
   git clone https://github.com/mjshuff23/evernote-clone.git
   ```

2. Install dependencies

```bash
   pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt
   ```

3. Create a **.env** file based on the example with proper settings for your development environment

4. Setup your PostgreSQL user, password and database and make sure it matches your **.env** file

5. Get into your pipenv, migrate your database, seed your database, and run your flask app

```bash
   pipenv shell
   ```

```bash
   flask db upgrade
   ```

```bash
   flask seed all
   ```

```bash
   flask run
   ```

6. To run the React App in development, checkout the [README](./react-app/README.md) inside the `react-app` directory.

***
*IMPORTANT!*
   If you add any python dependencies to your pipfiles, you'll need to regenerate your requirements.txt before deployment.
   You can do this by running:

```bash
   pipenv lock -r > requirements.txt
   ```

*ALSO IMPORTANT!*
   psycopg2-binary MUST remain a dev dependency because you can't install it on apline-linux.
   There is a layer in the Dockerfile that will install psycopg2 (not binary) for us.
***

### Deploy to Heroku

1. Create a new project on Heroku
2. Under Resources click "Find more add-ons" and add the add on called "Heroku Postgres"
3. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command-line)
4. Run

```bash
   heroku login
   ```

5. Login to the heroku container registry

```bash
   heroku container:login
   ```

6. Update the `REACT_APP_BASE_URL` variable in the Dockerfile.
   This should be the full URL of your Heroku app: i.e. "https://flask-react-aa.herokuapp.com"
7. Push your docker container to heroku from the root directory of your project.
   This will build the dockerfile and push the image to your heroku container registry

```bash
   heroku container:push web -a {NAME_OF_HEROKU_APP}
   ```

8. Release your docker container to heroku

```bash
   heroku container:release web -a {NAME_OF_HEROKU_APP}
   ```

9. set up your database:

```bash
   heroku run -a {NAME_OF_HEROKU_APP} python -m flask db upgrade
   heroku run -a {NAME_OF_HEROKU_APP} python -m flask seed all
   ```

10. Under Settings find "Config Vars" and add any additional/secret .env variables.

11. profit

evernote-clone

evernote-clone 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

evernote-clone

evernote-clone 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README