<commit_before># Another-chance
Another chance is an application for animal non profit organizations to store and manage animal blood donors.

## User Stories

* As a Veterinarian,
+ I want access to an animal donor database that I can quickly query records by animal type & location.
+ I want to be able to create, edit, and retrieve animal records.
+ I want to view all existing animal records.

* As an Administrative User,
+ I want to create, edit, retrieve and delete User accounts.
+ I want to view how many Users are in the database.
+ I want to view how many Animals are in the database.

### Access levels

Admins - Full CRUD (create, read, update, delete) access to ALL records and Users.

Users - Veterinarians and staff will be able to search, create, and update animal records. Users may delete records they created, but cannot delete records from other Vets. Users can also edit their own profile information.

### Authorization

Only authorized users may login and view the animal donor database. Authorization is handled through Passport.JS. A JSON Web Token is issued to each user upon new account, and upon login the token is verified with the database.

### User account creation JSON model example

```
firstName : Glen,
lastName : Pham,
email : <EMAIL>,
company : Philanthropist Coders,
position : Web Developer,
phone : 111-111-1111
```

### Animal donor JSON model example
Bloodtype will correlate to type of animal.

```
name: molly,
type: dog,
breed: pomeranian,
weight: 2kg,
age: 15 months,
bloodType: DEA 1.1,
contactName: <NAME>,
contactNumber: 111-111-1111,
vetName: Mrs. Lee,
location: Puerto Rico,
photo: cutest_dog.jpg,
createdBy: <NAME>
```<commit_msg>updates readme<commit_after># Another-chance
Another chance is an application for animal non profit organizations to store and manage animal blood donors.

## User Stories

#### As a Veterinarian,
+ I want access to an animal donor database that I can quickly query records by animal type & location.
+ I want to be able to create, edit, and retrieve animal records.
+ I want to view all existing animal records.

#### As an Administrative User,
+ I want to create, edit, retrieve and delete User accounts.
+ I want to view how many Users are in the database.
+ I want to view how many Animals are in the database.

#### As a Developer,
+ I want to gain a sense of purpose and make my heart feel all warm and fuzzy by using my skills to perform altruistic work.
+ I want to write clean, semantic, readable code with comments so that other users may contribute.


### Access levels

Admins - Full CRUD (create, read, update, delete) access to ALL records and Users.

Users - Veterinarians and staff will be able to search, create, and update animal records. Users may delete records they created, but cannot delete records from other Vets. Users can also edit their own profile information.

### Authorization

Only authorized users may login and view the animal donor database. Authorization is handled through Passport.JS. A JSON Web Token is issued to each user upon new account, and upon login the token is verified with the database.

### User account creation JSON model example

```
firstName : Glen,
lastName : Pham,
email : <EMAIL>,
company : Philanthropist Coders,
position : Web Developer,
phone : 111-111-1111
```

### Animal donor JSON model example
Bloodtype will correlate to type of animal.

```
name: molly,
type: dog,
breed: pomeranian,
weight: 2kg,
age: 15 months,
bloodType: DEA 1.1,
contactName: <NAME>,
contactNumber: 111-111-1111,
vetName: Mrs. Lee,
location: Puerto Rico,
photo: cutest_dog.jpg,
createdBy: <NAME>
```
## Technology Stacks

#### Server side
* Node
* Express
* MongoDB
* Passport

#### Client side
* React
* Redux
* Create-React-App
{'fraction_non_alphanumeric': 0.07352157698454981, 'fraction_numerical': 0.013319126265316995, 'mean_word_length': 4.364285714285714, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '582258', 'n_tokens_mistral': 1081, 'n_tokens_neox': 999, 'n_words': 554}