Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Project Description. Update 1.0.
  • Loading branch information
juicebct authored Feb 2, 2025
1 parent 19ffe0b commit cba6ce5
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
![image-2](https://github.com/user-attachments/assets/6d151f75-81f3-4a79-b833-b4b5fc26bf94)

## Overview
**Nickly** - a tool for creating unique RP nicknames for GTA SAMP/CRMP, GTA 5 RP and other games with RolePlay modes. Choose a character's gender and nationality to get a stylish and memorable name for any RolePlay server.

## Key Features
- **Generation of nicknames by parameters:** A large number of first and last names for different genders and nationalities are available for generation.
- **Languages:** Language change is available *(Currently only English and Russian)*.
- **Adaptability:** The interface is fully adaptable to different device screen sizes.
- **User-friendly and intuitive interface.**

## Website screenshot
<img width="1512" alt="Screenshot 2025-02-02 at 13 44 50" src="https://github.com/user-attachments/assets/b9594f84-c487-43b5-9504-33b6bb1459e5" />

## Technologies and development

- **Frontend:**

Responsible for the visual presentation and interactivity of the application. Built with **HTML5**, **CSS3**, and **JavaScript** to create a responsive, user-friendly interface.

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white) ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white) ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

- **Data Management:**

**JSON** was used to store parameters for first and last names for generation as well as for localization.

![Static Badge](https://img.shields.io/badge/JSON-0243E7?style=for-the-badge&logo=JSON)

- **Design:**

The design was created by me in **Figma**, featuring **prototyping** and reusable **components** for consistent UI/UX. The website was developed based on this design to maintain visual and functional accuracy.

<a href="https://www.figma.com/design/1csNmOCC9NujtOgbEHjNxq/%F0%9F%92%BB-Website-Design-%2F-Nickly---Online-RolePlay-nickname-generator?node-id=93-1348&t=4gvePGcdPhLX8V2s-1">
<img alt="Static Badge" src="https://img.shields.io/badge/Explore_the_project_in_Figma_(clickable)-242529?style=for-the-badge&logo=FIGMA">
</a>

## Future plans

The project will continue to be maintained and improved. At the moment it is planned to implement:

- Adding more language to the site interface.
- Adding more parameters for generation: new nationalities, new first and last names for existing ones.

*The list will be added and updated.*
*You can suggest your idea for updating in Discussions.*

0 comments on commit cba6ce5

Please sign in to comment.